MCP server that provides code agents with architectural context - ERD diagrams, code policies, API documentation, service relationships, and best practices.
Overview
This is a Model Context Protocol (MCP) server built with Rust that serves as an architectural context provider for AI coding agents. It offers tools and resources to help agents understand system architecture, relationships, and coding standards.
MCP server that gives code agents architectural context - ERD diagrams, code policies, API docs, service relationships, and best practices.
Estrelas
2
Ferramentas
—
Disponibilidade
—
Supported Document Types
The server supports scanning and providing access to various types of architectural and technical documentation:
Architecture Diagrams
C4 Diagrams: Context (C1), Container (C2), Component (C3), and Service (C4) diagrams
ERD Diagrams: Entity Relationship Diagrams for database schemas
ADR Documents: Architecture Decision Records
OpenAPI Specifications: REST API documentation in YAML format
Document Categories
Agreements: API contracts, service agreements, and technical specifications
Architecture: C4 diagrams, ERD diagrams, and ADR documents
OpenAPI: REST API specifications and endpoint documentation
Backend: PHP, Go, and other backend documentation
Frontend: JavaScript, TypeScript, and frontend documentation
Supported File Formats
Markdown: .md files
MDX: .mdx files (Markdown with JSX components)
Text: .txt files
YAML: .yaml files (OpenAPI specifications)
Available MCP Tools
The server provides 5 powerful tools for architectural documentation analysis:
1. get_resource_content
📄 Get Documentation Resource Content
Purpose: Retrieves content from specific documentation files using docs:// paths
Parameters:
path (string): Resource path in format docs://path/to/file
Use Cases: Reading specific architecture docs, API specs, guides, and technical documentation
cargo run --release -- --docs-root ./example_docs/docs/content
The server will start on 127.0.0.1:8010 by default.
Configuring Cursor to Use the MCP Server
Important: This MCP server uses HTTP transport and must be running as a separate process. The stdio transport is not supported because the server outputs logs to stdout, which interferes with the JSON protocol.
To use this MCP server with Cursor:
Start the MCP Server (must be running before configuring Cursor):
Option A: Using Cargo:
cargo run --release -- --docs-root ./example_docs/docs/content
Automatic MCP Integration (Optional):
For automatic MCP tool usage without explicit "use arch-mcp" commands, you can add the following section to your AGENTS.md file:
## MCP (Model Context Protocol)
### arch-mcp Integration
Always use arch-mcp when you need to analyze project documentation, understand architectural decisions, or work with ADR (Architecture Decision Records). This tool provides comprehensive project analysis and documentation insights.
**Key Features:**
- **Project Overview**: Complete project statistics and documentation coverage
- **ADR Analysis**: Architecture Decision Records for understanding design choices
- **API Documentation**: Service agreements and API contracts
- **C4 Diagrams**: Context, Container, Component, and Code level diagrams
- **ERD Analysis**: Entity Relationship Diagrams for database design
- **Technical Specifications**: Detailed specs by programming language and area
- **Agreements**: Service contracts and technical agreements
- **Architecture Documentation**: Comprehensive architectural documentation
**When to Use ArchMCP:**
- Understanding project architecture and design decisions
- Analyzing existing documentation and specifications
- Finding specific technical specifications and agreements
- Reviewing architectural decisions and ADR history
- Getting project statistics and documentation coverage
- Working with database design and ERD diagrams
- Understanding service agreements and API contracts
- Analyzing C4 architecture diagrams
This will enable the AI agent to automatically use arch-mcp tools when appropriate, without requiring explicit "use arch-mcp" commands in prompts.
Note: For remote server access, VPN connection is required.
Usage
Running the Server
cargo run --release -- --docs-root ./example_docs/docs/content
MCP Inspector
To inspect and test the MCP server, use the official MCP inspector:
Ainda não há lista de ferramentas. Servidores remotos recebem uma após a primeira verificação de saúde.
Perguntas frequentes
Perguntas
Como instalo Arch?
Copie nesta página a configuração stdio para Cursor, Claude Desktop, Claude Code ou VS Code. Ela usa a instalação do publicador, não um proxy do PlugMCP.
Arch precisa de uma chave de API?
Este registro não lista nenhuma variável de ambiente obrigatória.
Qual transporte Arch usa?
Arch roda localmente via stdio.
Quando Arch foi verificado pela última vez?
Última verificação: 2026-11-05. MCP server that gives code agents architectural context - ERD diagrams, code policies, API docs, service relationships, and best practices.