Docy: Documentation at Your AI's Fingertips
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
**Supercharge your AI assistant with instant access to technical documentation.**
Docy gives your AI direct access to the technical documentation it needs, right when it needs it. No more outdated information, broken links, or rate limits - just accurate, real-time documentation access for more precise coding assistance.
Why Choose Docy?
- **Instant Documentation Access**: Direct access to docs from React, Python, crawl4ai, and any other tech stack you use
- **Hot-Reload Support**: Add new documentation sources on-the-fly without restarting - just edit the .docy.urls file!
- **Intelligent Caching**: Reduces latency and external requests while maintaining fresh content
- **Self-Hosted Control**: Keep your documentation access within your security perimeter
- **Seamless MCP Integration**: Works effortlessly with Claude, VS Code, and other MCP-enabled AI tools
> **Note**: Claude may default to using its built-in WebFetchTool instead of Docy. To explicitly request Docy's functionality, use a callout like: "Please use Docy to find..."
Docy MCP Server
A Model Context Protocol server that provides documentation access capabilities. This server enables LLMs to search and retrieve content from documentation websites by scraping them with crawl4ai. Built with FastMCP v2.
Using Docy
Here are examples of how Docy can help with common documentation tasks:
With Docy, Claude Code can directly access and analyze documentation from configured sources, making it more effective at providing accurate, documentation-based guidance.
To ensure Claude Code prioritizes Docy for documentation-related tasks, add the following guidelines to your project's CLAUDE.md file:
Adding these instructions to your CLAUDE.md file helps Claude Code consistently use Docy instead of its built-in web fetch capabilities when working with documentation.
Available Tools
- list_documentation_sources_tool - List all available documentation sources
- No parameters required
- fetch_documentation_page - Fetch the content of a documentation page by URL as markdown
- url (string, required): The URL to fetch content from
- fetch_document_links - Fetch all links from a documentation page
- url (string, required): The URL to fetch links from
Prompts
- **documentation_sources**
- List all available documentation sources with their URLs and types
- No arguments required
- **documentation_page**
- Fetch the full content of a documentation page at a specific URL as markdown
- Arguments:
- url (string, required): URL of the specific documentation page to get
- **documentation_links**
- Fetch all links from a documentation page to discover related content
- Arguments:
- url (string, required): URL of the documentation page to get links from
Installation
Using uv (recommended)
When using uv no specific installation is needed. We will
use uvx to directly run *mcp-server-docy*.
Using PIP
Alternatively you can install mcp-server-docy via pip:
After installation, you can run it as a script using:
Using Docker
You can also use the Docker image:
Global Server Setup
For teams or multi-project development, check out the server/README.md for instructions on running a persistent SSE server that can be shared across multiple projects. This setup allows you to maintain a single Docy instance with shared documentation URLs and cache.
Configuration
Configure for Claude.app
Add to your Claude settings:
Using uvx
Using docker
Using pip installation
Configure for VS Code
For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).
Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.