Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

1.1 KB
Raw Blame

Agent Docs

This directory is the system of record for agent-facing repo guidance. Keep topic pages small, specific, and mechanically checkable where possible.

Recommended Reading Order

  1. quickstart.md
  2. architecture/overview.md
  3. the task-specific page for the area you are changing

If the change touches remote hosts or Switch rooms, read architecture/remote-execution.md and architecture/switch-rooms.md too — Switch Console runs agents on SSH hosts as well as locally, and both transports share the persistent SDK host.

Directory Layout

  • architecture/
    • system structure and major code ownership boundaries
  • workflows/
    • task-oriented procedures like testing
  • integrations/
    • agent provider and MCP guidance
  • risky-areas/
    • places where incorrect changes are expensive
  • conventions/
    • coding contracts and repo rules

Maintenance Rules

  • Prefer one page per concrete topic.
  • Avoid volatile counts unless you can verify them cheaply.
  • Link to the source-of-truth file paths.
  • Update the smallest relevant page instead of expanding AGENTS.md.