MCP Docs Server
Fornece acesso direto a arquivos de documentação local através de um arquivo context.md na raiz do projeto.
Documentação
Servidor MCP de Documentação
Um servidor leve de Model Context Protocol (MCP) que fornece acesso direto a arquivos de documentação locais — uma alternativa simples a pipelines complexos de RAG para contexto específico de projetos.
Visão Geral
Este servidor MCP lê um único arquivo markdown (context.md) e expõe seu conteúdo por meio de duas ferramentas simples:
get_context_overview(): Lista todos os títulos de seçõessearch_context(query): Pesquisa conteúdo em todas as seções
Perfeito para dar a LLMs acesso à documentação do projeto sem a complexidade de bancos de dados vetoriais ou modelos de embedding.
Recursos
- Zero dependências além do SDK Python do MCP
- Extremamente rápido — acesso direto a arquivos, sem busca vetorial
- Configuração simples — funciona com clientes MCP GUI e CLI
- Multiplataforma — inclui wrapper de shell para compatibilidade com macOS/Linux
- Tratamento robusto de erros — suporte abrangente a logging e depuração
Instalação
Pré-requisitos
- Python 3.11+
- Cliente MCP (Claude Desktop, cline, etc.)
Configuração
- Clone este repositório:
git clone https://github.com/unlock-mcp/mcp-docs-server.git
cd mcp-docs-server
- Instale as dependências:
pip install -r requirements.txt
- Crie seu arquivo de documentação:
# Create a context.md file in the project root with your documentation
echo "# My Project Docs\n\nThis is my documentation." > context.md
Configuração do Cliente
Para Claude Desktop (clientes GUI)
Use o wrapper de shell para execução confiável:
- Torne o wrapper executável:
chmod +x run_context_server.sh
- Instale o servidor:
mcp install ./run_context_server.sh --name "docs-server"
Para cline e clientes CLI
Adicione ao seu arquivo de configuração MCP:
{
"mcpServers": {
"docs-server": {
"timeout": 60,
"type": "stdio",
"command": "/opt/homebrew/bin/python3.11",
"args": [
"/path/to/mcp-docs-server/mcp_context_server.py"
],
"env": {}
}
}
}
Nota: Atualize o caminho do Python para corresponder ao seu sistema (which python3.11)
Desenvolvimento
Testes
Use as ferramentas de desenvolvimento MCP para testes fáceis:
mcp dev ./run_context_server.sh
Isso inicia um inspetor baseado na web para testar seu servidor.
Depuração
O servidor registra logs em stderr para depuração. Verifique os logs do seu cliente MCP se encontrar problemas.
Problemas comuns:
- Erros ENOENT: Use o wrapper de shell ou especifique o caminho completo do Python
- Erros de importação: Certifique-se de que
mcp[cli]>=1.2.0está instalado - Arquivo não encontrado: Verifique se
context.mdexiste na raiz do projeto
Estrutura de Arquivos
mcp-docs-server/
├── mcp_context_server.py # Main server implementation
├── run_context_server.sh # Shell wrapper for GUI clients
├── requirements.txt # Python dependencies
├── context.md # Your documentation (create this)
└── README.md # This file
Uso
Após a configuração, você pode usar estas ferramentas no seu cliente MCP:
- Obter visão geral: "Quais seções estão disponíveis na documentação?"
- Pesquisar conteúdo: "Pesquisar por autenticação na documentação"
- Consultas específicas: "Como configuro o banco de dados?"
Tutorial
Para um passo a passo completo de como construir este servidor do zero, incluindo armadilhas comuns e soluções, veja o tutorial completo: Ditching RAG: Building a Local MCP Server for Your Docs
Contribuições
Contribuições são bem-vindas! Sinta-se à vontade para enviar issues e pull requests.
Licença
Licença MIT — consulte o arquivo LICENSE para detalhes.
Construído com ❤️ pela equipe UnlockMCP.