Documentation assistant leveraging Model Context Protocol
Wellknown found it in public sources; nobody has proven control of it yet. Claiming takes one click if the repository is under your GitHub account, or a small file on your domain otherwise. Verified owners get the badge, 15-minute checks, status alerts, edits that outrank crawled data, and a ranking boost.
Agents can do it too: POST https://wellknown.network/api/v1/claims with {"agent":"iflow-mcp-saharcarmel-almanac","method":"well_known_file"} — machine-readable steps at claim.json, guide at /docs/claim.
Everything here was measured by our prober or read from a registry. Nothing is self-reported.
Attributed to the source that supplied each field. Treated as claims, not facts.
# TheAlmanac A documentation assistant leveraging Model Context Protocol (MCP) to help programmers access the most up-to-date and relevant information from API and software documentation. ## Features - **Documentation Crawler**: Automatically download and store documentation locally - **Simple Search**: Find relevant documentation sections quickly - **MCP Integration**: Provide LLMs with tools to access documentation - **File-based Storage**: Efficiently organize documentation in a simple file structure - **MCP Server**: HTTP server for LLM tool access ## Installation ```bash # Clone the repository git clone https://github.com/yourusername/TheAlmanac.git cd TheAlmanac # Install dependencies with UV uv pip install -e . ``` ## Usage ### Managing Documentation Sources ```bash # Add a documentation source almanac add python https://docs.python.org/3/ # List all documentation sources almanac list # Download documentation almanac download python # Remove a documentation source almanac remove python ``` ### Searching Documentation ```bash # Search all documentation almanac search "context manager" # Search a specific source almanac search "context manager" --source python # Search with more context almanac search "context manager" --context-lines 5 ``` ### Running the MCP Server ```bash # Start the HTTP server (for direct API access) almanac serve --transport http # Start the MCP server (for integration with MCP clients like Claude for Desktop) almanac serve --transport stdio # Start on a specific host and port (for HTTP transport) almanac serve --transport http --host 0.0.0.0 --port 9000 ``` ## MCP Tools TheAlmanac provides the following MCP tools: 1. **search_documentation**: Search for relevant documentation 2. **get_documentation**: Get a specific document or section 3. **download_documentation**: Download a new documentation source 4. **list_documentation**: List available documentation sources ## Example Scripts The `scripts` directory conta…
Mapped onto the structured taxonomy from declared text and observed tool names. Confidence shown for derived entries.
Every source is kept verbatim. Field changes are logged as events.