AgentDoc / Get started · open-source alpha

Start with one source your agent can cite.

Install the CLI, search one Markdown file, then connect your coding agent. You can add review status and code links with typed claims when you need them. No Cloud account or model credential is required for this first run.

Watch how it works first, 1:46

01 · Install

Install the CLI and MCP server

AgentDoc v1.0.0-alpha.1 has prebuilt archives for macOS on Apple Silicon and Linux on x86_64 or ARM64. The command downloads an archive and checksum, verifies the archive, then installs adoc and adoc-mcp to /usr/local/bin. The final step asks for sudo access.

aarch64-apple-darwin

curl -fsSLO https://github.com/agentdoc-dev/adoc/releases/download/v1.0.0-alpha.1/adoc-v1.0.0-alpha.1-aarch64-apple-darwin.tar.gz && \
curl -fsSLO https://github.com/agentdoc-dev/adoc/releases/download/v1.0.0-alpha.1/adoc-v1.0.0-alpha.1-aarch64-apple-darwin.tar.gz.sha256 && \
shasum -a 256 -c adoc-v1.0.0-alpha.1-aarch64-apple-darwin.tar.gz.sha256 && \
tar -xzf adoc-v1.0.0-alpha.1-aarch64-apple-darwin.tar.gz && \
sudo install -d /usr/local/bin && \
sudo install adoc adoc-mcp /usr/local/bin/

You should seeadoc-v1.0.0-alpha.1-aarch64-apple-darwin.tar.gz: followed by OK from the checksum step, then no errors from the install.

The release page (opens in a new tab) has checksums and build provenance. Stop if verification fails. macOS distribution signing and notarization are not promised; use the source build if your Mac blocks the archive.

Build from source

Clone the adoc repository (opens in a new tab), install Rust 1.95.0 and native build tools, then run this in the checkout. Use both binaries under target/release/ from the same revision.

checkout root

cargo build --release --locked -p adoc-cli -p adoc-mcp

02 · Find a source

Get your first citation

Run this with adoc on your PATH. It creates a new agentdoc-demo directory and stops if that directory already exists. The sample Markdown is a starting point; add your own docs under docs/ afterward. Use a nested folder such as docs/team/ for plain Markdown files.

any empty folder

mkdir agentdoc-demo && \
cd agentdoc-demo && \
adoc init && \
mkdir -p docs/team && \
printf '# Release policy\n\nDeployments need two reviewers.\n' > docs/team/releases.md && \
adoc check && \
adoc build --no-embeddings && \
adoc search 'two reviewers' --lexical

You should seeThe line Deployments need two reviewers. with its source, docs/team/releases.md and the line number.

Search shows the Markdown text and its source file and line. adoc init does not overwrite an existing config or starter file. In an existing repo, set docs_path to your docs folder; see the CLI reference (opens in a new tab). adoc check checks structure and declared evidence; people decide what is verified.

This first build uses lexical search and downloads no model. For semantic search, run adoc build without the flag. First use downloads the FastEmbed model Xenova/bge-small-en-v1.5 from Hugging Face; inference then runs locally. For an offline path, keep --no-embeddings and --lexical.

03 · Connect an agent

Give your coding agent access

After adoc build, register the local MCP server. These commands use /usr/local/bin/adoc-mcp. If you built from source, replace that path with the absolute path to target/release/adoc-mcp in your checkout.

Claude Code

project root

claude mcp add --transport stdio --scope local \
  agentdoc -- /usr/local/bin/adoc-mcp

Codex CLI

project root

codex mcp add agentdoc -- /usr/local/bin/adoc-mcp

You should seeAgentDoc listed as connected: /mcp in Claude Code, or codex mcp list in Codex. Then ask it to search your docs and cite the source.

Run these registration commands from the project root, then start your agent there. Pass the absolute project directory as project_root in AgentDoc tool calls if your client starts the server elsewhere. The MCP guide (opens in a new tab) covers tools and client configuration.

On AgentDoc Cloud? Your workspace's Getting started page shows its hosted MCP URL: open AgentDoc Cloud (opens in a new tab).

The CLI and MCP server make no model calls. Your coding agent controls whether retrieved content reaches its model provider.

Next · Keep a claim

Give an important fact a review status.

Plain Markdown is already searchable and citable. For a fact reviewers must track, add one typed claim in an AgentDoc Source (.adoc) file. The Source reference (opens in a new tab) shows the claim syntax and evidence fields.

Want PR reports later?

The GitHub Action is optional and reports without a Claude credential. Model-assisted drafting requires separate credentials and configuration.

Set up the GitHub Action

AgentDoc is pre-release software. See the maturity and limits (opens in a new tab) and CLI reference (opens in a new tab) when you need more detail.