agent-docs-mcp
Provides access to AGENTS.md documentation from GitHub repositories, enabling AI agents to automatically reference coding guidelines and project conventions stored in AGENTS.md files.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@agent-docs-mcp show me the AGENTS.md documentation for my project"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Agent Docs MCP
MCP Server that provides coding agents with automatic access to AGENTS.md documentation from GitHub repositories. This enables AI assistants to understand your codebase conventions, patterns, and guidelines without manual intervention.
Why Use This?
When working with AI coding agents, they often need context about:
Your coding standards and conventions
Architecture decisions and patterns
API usage and best practices
Project-specific guidelines
This MCP server makes that documentation automatically available to agents, so they can:
Automatically reference your coding guidelines when making changes
Search for specific patterns or implementations
Understand context before implementing features
Follow conventions without being explicitly told
Related MCP server: GitHub MCP Server
Getting Started
Add the following to your MCP configuration to connect your AI assistant to the documentation:
Configuration
{
"servers": {
"agent-docs-mcp": {
"command": "npx",
"args": ["@jbouder/agent-docs-mcp"],
"env": {
"REPO_URLS": "[\"https://github.com/jbouder/acolyte\",\"https://github.com/metrostar/comet\"]"
}
}
}
}This will automatically make AGENTS.md files available from:
https://github.com/jbouder/acolyte/blob/main/AGENTS.mdhttps://github.com/MetroStar/comet/blob/main/AGENTS.md
Environment Variables:
REPO_URLS: JSON array of GitHub repository URLsThe server automatically adds
/blob/mainif not specifiedYou can specify branches:
https://github.com/owner/repo/blob/developYou can specify subdirectories:
https://github.com/owner/repo/blob/main/docs
How It Works
Resources (Automatic)
The documentation is exposed as MCP resources, which means agents can automatically access it when working on your code. No manual tool calls needed!
Tools (On-Demand)
Tool | When Agents Use It |
| To read coding guidelines, patterns, and conventions before implementing features |
| To find specific information about APIs, patterns, or implementation details |
Agents will automatically use these tools when:
Starting work on a new feature
Fixing bugs and needing context
Implementing APIs or following patterns
Understanding architecture decisions
Supported URL Formats
The server intelligently handles various GitHub URL formats:
https://github.com/owner/repo→ auto-adds/blob/main/AGENTS.mdhttps://github.com/owner/repo/blob/branch→ adds/AGENTS.mdhttps://github.com/owner/repo/blob/branch/path→ adds/AGENTS.mdhttps://github.com/owner/repo/tree/branch→ converts to blob and adds/AGENTS.md
All URLs are automatically converted to raw content URLs for fetching.
Creating AGENTS.md
Create an AGENTS.md file in your repository with coding guidelines, patterns, and context. Example:
# Agent Guidelines for MyProject
## Architecture
- We use a microservices architecture
- API Gateway pattern for routing
- Event-driven communication between services
## Coding Standards
- TypeScript with strict mode enabled
- ESLint configuration in .eslintrc.json
- Jest for testing with >80% coverage requirement
## API Patterns
- All endpoints use RESTful conventions
- Authentication via JWT tokens
- Rate limiting: 100 requests per minute
## Common Tasks
### Adding a New API Endpoint
1. Create route in `src/routes/`
2. Add controller in `src/controllers/`
3. Write tests in `__tests__/`
4. Update OpenAPI spec
### Database Migrations
Use `npm run migrate` to run migrations...Example Agent Interactions
With this MCP server configured, agents can:
Automatic Context:
Agent: "I need to implement a new API endpoint for user profiles"
[Agent automatically reads documentation]
Agent: "Based on the guidelines, I'll create the route in src/routes/,
add a controller, write tests, and update the OpenAPI spec..."Searching for Patterns:
You: "Add authentication to the new endpoint"
Agent: [Searches docs for "authentication"]
Agent: "I found the JWT authentication pattern. I'll use the existing
middleware from src/middleware/auth.ts..."Running Locally
The MCP server is built using the official TypeScript MCP SDK and follows the existing project structure and patterns.
Build the Server
npm run buildConfiguring MCP Client for your server
{
"mcpServers": {
"agent-docs-mcp": {
"command": "node",
"args": ["/ABSOLUTE/PATH/TO/YOUR/PROJECT/agent-docs-mcp/dist/index.js"],
"env": {
"REPO_URLS": "[\"https://github.com/jbouder/acolyte\"]"
}
}
}
}Available Tools
2 toolsread_agent_docsA
Read agent documentation and coding guidelines from configured repositories. Use this when you need context about how to work with a codebase, understand coding patterns, architecture decisions, or get implementation guidelines. The documentation provides best practices, conventions, and important context for making code changes.
Inputs: repository.
search_agent_docsA
Search through agent documentation for specific information about coding patterns, architecture, APIs, or implementation details. Use this when you need to find specific guidance before implementing a feature or fixing a bug.
Inputs: query (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 2 tools
read_agent_docs and search_agent_docs are clearly differentiated by mode: one retrieves full documentation/context, the other finds specific guidance. There is some conceptual overlap since both access the same docs, but descriptions make the boundary clear.
Both tools follow the same verb_noun pattern: read_agent_docs and search_agent_docs. The naming is consistent, predictable, and clearly indicates what each tool does.
With only two tools, the server feels minimal, but the scope is narrowly focused on documentation access. This falls into the borderline range where 1-2 tools feels thin, though it is not unreasonable for a docs-only server.
Read and search cover the main documentation-retrieval workflows with no obvious dead ends. A list/discovery tool could be a minor enhancement, but it is not strictly necessary since search can locate relevant docs.
Related MCP Connectors
An MCP server that gives your AI access to the source code and docs of all public github repos
MCP server for agentverse documentation, generated by doc2mcp.
Official MCP server for Agentwork — delegate tasks to AI agents with human-in-the-loop
Driflyte MCP server which lets AI assistants query topic-specific knowledge from web and GitHub.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceAn MCP server that gives AI agents structured code understanding and precise code intelligence via local indexing of AST, call graphs, and semantic search.77 npm4Apache 2.0
- AlicenseNot gradedqualityDmaintenanceAn MCP server that enables AI agents to directly manage GitHub repositories, including PRs, issues, and code search, using natural language.MIT
- AlicenseAqualityBmaintenanceMCP server that analyzes codebases with tree-sitter and generates AGENTS.md files for AI agents.344 PyPI6MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that enables AI agents to navigate and understand codebases through file descriptions, semantic search, and code recommendations without repeatedly scanning files.MIT