Skip to main content

Documentation Index

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

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

When an agent processes a question, it doesn’t see a flat list of documents. Instead, Circuit assembles a virtual file system that gives the agent structured access to everything it needs: your documents, the agent’s instructions, and the user’s personal index. Understanding this file system helps you reason about what an agent can see, why it returns certain results, and how to organize your content for the best outcomes.

​
Structure

Every agent session gets a file system rooted at /Circuit with three directories: 
/Circuit/
├── User/
├── Skills/
└── References/
DirectoryContentsAccess
UserThe current user’s home indexRead and write
SkillsThe agent’s instructions and skillsRead-only for users, writable by admins
ReferencesAll indexes in the agent’s reference scope, mounted by nameRead-only

​
User

The /Circuit/User directory contains the current user’s home index. This is a personal space where users can upload their own documents. Because it’s part of the file system, the agent can search and read these documents alongside everything else. Users have read and write access to their home index, so they can add, update, or remove documents at any time.

​
Skills

The /Circuit/Skills directory contains the agent’s configuration: 
/Circuit/Skills/
├── AGENT.md
└── warranty-lookup/
    ├── SKILL.md
    └── warranty-reference.pdf
  • AGENT.md holds the agent’s top-level instructions: response style, domain rules, and behavioral guidance set by the administrator.
  • Each skill gets its own subdirectory containing a SKILL.md file with the skill’s instructions, plus any reference files the skill needs.
This is how the agent “knows” its own configuration. When it receives a question, it can read its instructions and skill definitions to determine how to respond.

​
References

The /Circuit/References directory contains every index in the agent’s reference scope, mounted as a subdirectory using the index name: 
/Circuit/References/
├── Product Manuals/
│   ├── installation-guide.pdf
│   ├── maintenance-procedures.docx
│   └── ...
├── Sales Playbook/
│   ├── pricing-2024.xlsx
│   ├── competitive-analysis.pdf
│   └── ...
└── Compliance Documents/
    └── ...
Each index appears as a folder containing all of its documents. When the agent searches for information, it navigates these directories to find relevant content.

​
How agents use the file system

When a user asks a question, the agent works through the file system in a natural way:
  1. Reads its instructions from /Circuit/Skills/AGENT.md to understand how it should behave
  2. Searches across /Circuit/References and /Circuit/User to find documents relevant to the question
  3. Reads specific document sections to build a detailed answer
  4. Cites the source documents so users can verify the information
The file system structure means the agent always knows where information came from. A citation from /Circuit/References/Product Manuals/installation-guide.pdf tells both the agent and the user exactly which index and document provided the answer.

​
What this means for administrators

The file system model has practical implications for how you set up agents:
  • Index names matter. Since indexes are mounted by name under /Circuit/References, clear and descriptive index names help the agent navigate and help users understand citations. “Product Technical Manuals” is more useful than “Index 3.”
  • Reference scope is the agent’s world. An agent can only see indexes mounted in its file system. If an index isn’t in the reference scope, it doesn’t exist to the agent. See agent configuration for how to manage reference scope.
  • Skills are visible to the agent. Everything in /Circuit/Skills is readable by the agent, so write instructions and skill definitions with the understanding that they shape the agent’s behavior directly.

​
What this means for users

  • Your home index is always available. Any documents you upload to your home index appear in /Circuit/User and are searchable by the agent alongside reference material. This is useful for uploading project-specific documents that aren’t in the shared indexes.
  • The agent can cross-reference. Because all indexes are in a single file system, the agent can combine information from your personal documents, the shared reference indexes, and its own skill definitions to give you a complete answer.