Skip to content

README.md

Latest commit

 

History

History
37 lines (29 loc) · 2.94 KB

README.md

File metadata and controls

37 lines (29 loc) · 2.94 KB
Raw

URI Agent documentation

The root README explains what URI Agent is and provides the shortest path to a working session. This directory owns the detailed product and contributor documentation.

Choose a document

Goal Document
Connect an editor or other ACP client, manage ACP sessions, or supply session-scoped MCP servers ACP v1
Understand read, exec, direct tools, protocol routing, MCP operations, built-ins, tasks, or output preservation Protocols, tasks, and output
Understand project instructions, or create and troubleshoot a Skill Startup context and Skills
Build, install, reload, or audit a trusted WASM plugin WASM plugins
Configure a model, credentials, MCP server, Agent environment variables, reasoning effort, output limits, offline mode, or a custom endpoint Models and configuration
Use the conversation, composer, commands, MCP manager, and navigation Terminal interface
Customize keys, use the embedded terminal, copy text, or attach images Keymaps, terminal, and attachments
Resume a session or understand persistence, the model/tool loop, retries, frozen context, and compaction Sessions and context
Change the codebase, find module ownership, preserve product contracts, or run verification Architecture and development
Prepare or configure a release Release process

Sources of truth

These documents explain stable concepts and cross-cutting behavior. More specific references remain authoritative:

  • uri-agent --help defines the current command-line interface.
  • The active model-tool schemas define direct-tool arguments; <protocol>://help defines a registered protocol's accepted addresses, string body, execution behavior, result routes, and limits.
  • uri-agent-docs://README.md exposes this documentation embedded in the running binary, independent of its startup working directory.
  • wasm_plugin://help publishes active WASM plugin state and routes to separate loading and authoring help pages.
  • F1 and :help show the active command and keymap reference after global and project overrides are applied.
  • The pi model catalog plus local models.json defines the available providers and models.
  • AGENTS.md is the concise entry point for coding agents; the development guide contains the detailed repository rules it references.

Documentation policy

  • Keep root README.md and README.zh-CN.md equivalent as adoption guides.
  • Detailed documents in docs/ are maintained in English only.
  • Put mutable detail in one authoritative document and link to it instead of copying it.
  • Keep protocol-specific model instructions in <protocol>://help; documentation here should explain how the protocol system fits together.