Skip to main content
Glama
agents-docs

agents-docs

by Lolaplex

Quickstart

pip install agents-docs && agents-docs init

Creates ~/.agents/docs/ (category dirs only), copies skills, and merges MCP into host configs whose directories already exist. Docsets are not seeded. Fetch one with agents-docs sync <name>.

TIP

🤖 Agent-Driven Setup: Give your coding agent this repo (clone or URL), then tell it to "install and set up agents-docs."

Source checkouts can also be installed and managed with vand.


Related MCP server: Speakeasy Docs MCP

What it does

Markdown on disk is the store (~/.agents/docs/, override AGENTS_DOCS_PATH). Search is header-aware BM25 in-process. No vector database, no embeddings.

Layer

Where

What lives there

Fact sheets

stacks/ models/ apis/ platforms/ custom/

Append-mostly notes agents file with write_doc

Docsets

one folder per catalog name or ingest

Fetched llms.txt / markdown, or a local folder

Search. search_docs ranks sections, not whole files. A named catalog docset is fetched when missing and refreshed when stale (7 days, ai-models 1 day).

Catalog sync does not rewrite fact sheets. sync / prune leave stacks|models|apis|platforms|custom alone.

Memory is a different store. User prefs, project decisions, and identity go to agents-memory. Do not dump READMEs or chat logs here. delete_doc is for a wrong, duplicate, or yanked sheet — not because a model is old.


Where it runs

Floor: any MCP client or a terminal. python -m agents_docs serve is enough.

init autowires hosts it finds. It does not install an IDE.

Layer

What you get

Who

Vault + MCP/CLI

Full tools, or the CLI mirrors below

Any MCP host / any shell

Autowire on init

Merge agents-docs into the host MCP file when that config directory already exists; copy docs-search and docs-sync

Cursor, Claude Desktop, Zed (context_servers), Antigravity / Gemini, Windsurf, Codex, Roo, Cline. Skills land in ~/.agents/skills, ~/.cursor/skills, ~/.gemini/config/skills

MCP without autowire: point the host at python -m agents_docs serve.


MCP tools

Primary surface. Agents file and search facts here.

Tool

What it does

search_docs

Header-aware BM25. category is all, a fact category, or a docset name

get_doc

Raw markdown of one sheet

write_doc

Append a dated section. overwrite=true replaces a wrong sheet

delete_doc

Drop a wrong, duplicate, or yanked sheet. No CLI mirror

list_docs

Fact sheets with category and size

list_catalog

The 21 names sync can fetch with no URL

sync_external_doc

Fetch a catalog name or a custom llms.txt / markdown URL

get_model_playbook

Model playbook text (model, default auto)

Eight tools. Full contract: abi/MCP.md.


CLI

Ops / install / batch. Vault writes mirror MCP. Machine-readable catalog: python -m agents_docs --help-json (do not scrape --help).

Command

Purpose

agents-docs init

Categories, skills, MCP merge. No docset download

agents-docs catalog

List the 21 catalog names

agents-docs sync <name> [--url URL]

Fetch a catalog item or a custom URL

agents-docs ingest <name> <path>

Copy a local markdown folder into the store

agents-docs search "<query>" [--docset NAME] [--top N]

BM25. CLI flag is --docset (MCP calls it category)

agents-docs list

Installed docsets with file and byte counts

agents-docs write NAME CONTENT [CATEGORY]

Append a fact. Alias: add. --overwrite replaces

agents-docs playbook [model]

Same text as get_model_playbook

agents-docs prune

Strip boilerplate in installed docsets

agents-docs serve

stdio MCP. Also the default when you pass no command

agents-docs skills / sync-mcp

Re-copy skills, or re-merge MCP, without the rest of init


ABI

Layout and contracts in abi/:


Tests

python tests/run_all_tests.py

License

MIT. See LICENSE.

Available Tools

8 tools
delete_docA

Delete a technical fact sheet that is wrong, duplicate, or yanked.

Do not delete because a fact is old. Old-but-still-true model/API notes stay.

Args: name: Document identifier to delete category: Category where the doc resides ('stacks', 'models', 'apis', 'platforms', 'custom')

Inputs: name (required), category. Returns: result

get_docA

Fetch the complete raw markdown of a technical fact sheet, spec, or playbook.

Args: name: Name or relative path of the doc (e.g. 'tailwind-v3', 'stacks/fastapi.md', 'coolify-db', 'ai-models/pricing_and_specs.md') category: Optional category filter ('stacks', 'models', 'apis', 'platforms', 'custom', or 'all').

Inputs: name (required), category. Returns: result

get_model_playbookA

Get self-awareness operational playbooks, strengths, traps, and best practices for AI models. Enables models to understand their own capabilities and optimize tool execution patterns.

Args: model: Model name or family (e.g. 'gemini-3.7-flash', 'claude-3.7-sonnet', 'gpt-4o', 'deepseek-r1', 'qwen', or 'auto').

Inputs: model. Returns: result

list_catalogA

List curated pre-configured framework docsets available for 1-click sync. Includes Svelte 5, FastAPI, Next.js, Supabase, Tailwind v3/v4, Tauri 2, Hono, MCP, WXT.

Inputs: no named parameters. Returns: result

list_docsB

List all indexed technical documents, fact sheets, API specs, and playbooks with category and size.

Args: category: Filter by category ('stacks', 'models', 'apis', 'platforms', 'custom', or 'all')

Inputs: category. Returns: result

search_docsA

Search hard technical facts, API specs, stack rules, model capabilities, and playbooks using header-aware BM25 ranking.

Args: query: Keywords, function signatures, syntax, or technical questions (e.g. 'runes $state', 'HTTPException', 'coolify postgres port', 'cdp tab focus') category: Target category ('stacks', 'models', 'apis', 'platforms', 'custom', or specific docset name, or 'all' to search everything). top_k: Number of relevant sections to return (default 4).

Inputs: query (required), top_k, category. Returns: result

sync_external_docB

Fetch/synchronize an external documentation set from curated catalog or custom llms.txt URL.

Args: name: Name of the catalog item (e.g. 'svelte-5', 'fastapi', 'tailwind-v3') or custom identifier. url: Optional custom URL (pointing to llms.txt, llms-full.txt, or raw markdown).

Inputs: name (required), url. Returns: result

write_docA

Append a durable technical fact (API spec, stack rule, model capability, platform note).

Default appends a dated section. Does not clobber. Use overwrite=True only to replace a wrong sheet. Hard tech facts belong here. User prefs and project fluid facts belong in agents-memory, not docs. delete_doc is for wrong/duplicate/yanked sheets — not for an old model that is still true.

Args: name: Short document identifier (e.g. 'powershell-gotchas', 'stripe-api', 'coolify-db-ports') content: Markdown fact to append (or full replacement when overwrite=True) category: One of 'stacks' (frameworks/libs), 'models' (LLM specs), 'apis' (protocol/APIs), 'platforms' (OS/Infra/DB), 'custom' overwrite: False (default) appends. True replaces the entire file.

Inputs: name (required), content (required), category, overwrite. Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4/5.0

    Scored across 8 tools

    Disambiguation5/5

    Each tool targets a clearly distinct operation: search vs. full fetch, write vs. delete vs. list, external sync vs. catalog listing, and a specialized model playbook. The descriptions explicitly delineate boundaries (e.g., write_doc for facts vs. agents-memory for prefs). No two tools can be easily confused.

    Naming Consistency5/5

    All tool names follow a consistent snake_case verb_noun pattern (search_docs, get_doc, write_doc, delete_doc, list_docs, sync_external_doc, get_model_playbook, list_catalog). There are no deviations in casing or verb style.

    Tool Count5/5

    Eight tools is well-scoped for a documentation management server. Each tool serves a unique purpose—retrieval, mutation, listing, external sync, and playbooks—with no redundancy or bloat.

    Completeness5/5

    The surface covers full CRUD (write with overwrite for update, get/search/list, delete) plus external synchronization, catalog browsing, and specialized model playbooks. No obvious gaps in the documentation lifecycle are apparent.

    Maintenance

    ActivityNo data
    ResponsivenessSyncing

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      B
      maintenance
      MCP server that gives AI coding agents on-demand access to private project docs via BM25 ranked search. One setup for Claude Code, Cursor, Codex, Gemini CLI, and more. Docs stay private, never in public repos.
      15
      16
      Apache 2.0
    • A
      license
      Not graded
      quality
      B
      maintenance
      A lightweight, domain-agnostic hybrid search engine for markdown corpora, exposed via the Model Context Protocol (MCP), optimized for serving SDK documentation to AI coding agents.
      9
      AGPL 3.0
    • A
      license
      A
      quality
      D
      maintenance
      Local-first context retrieval engine that serves precise documentation chunks to coding agents via MCP, ensuring high-confidence context for code generation.
      3
      MIT