Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upsonic.ai/llms.txt

Use this file to discover all available pages before exploring further.

The AGENTS.md feature allows you to configure your AutonomousAgent using a markdown file stored in the workspace directory. When a workspace is set, the agent reads the AGENTS.md file and includes it in the system prompt, providing persistent configuration and behavioral guidelines.

​
Overview

When you set a workspace path on an AutonomousAgent:
  1. Configuration Loading: The agent reads the AGENTS.md file from the workspace folder and includes it in the system prompt
  2. Session Greeting: You can call execute_workspace_greeting() to generate a personalized greeting based on the configuration

​
Example

from upsonic import AutonomousAgent, Task

# Create an autonomous agent with workspace
agent = AutonomousAgent(
    model="anthropic/claude-sonnet-4-5",
    workspace="/path/to/project",
    session_id="user_session_001"
)

# Execute the workspace greeting (optional, for new sessions)
greeting = agent.execute_workspace_greeting()
print(greeting)

# Run tasks - the AGENTS.md content is included in the system prompt
task = Task("What can you help me with?")
agent.print_do(task)

​
The AGENTS.md File

Create an AGENTS.md file in your workspace folder to define your agent’s behavior. We provide a ready-to-use template with memory management, safety rules, group chat guidelines, and more.

AGENTS.md Template

Get the full AGENTS.md template you can copy and customize for your workspace.
The content of this file is automatically injected into the agent’s system prompt wrapped in <AgentConfiguration> tags.

​
How It Works

When the AutonomousAgent initializes with a workspace:
  1. It checks if an AGENTS.md file exists in the workspace directory
  2. If found, the file content is read and appended to the system prompt
  3. The agent uses these instructions alongside its built-in filesystem and shell tool guidelines
  4. The greeting method can introduce the agent based on its configuration

​
Integration with Interfaces

When using Upsonic interfaces (Telegram, Slack, WhatsApp), the workspace greeting is automatically called when a user resets their session with the /reset command. The greeting response is sent to the user, providing a fresh start with a personalized introduction.