Codebase MCP Server

Codebase MCP Server

Servidor do Model Context Protocol para análise segura e eficiente de Codebase

Recursos Principais • Linguagens Suportadas • Ferramentas • Início Rápido • Build • Contribuição

🌟 Recursos Principais

• Acesso Seguro: Restringe operações de arquivos ao diretório raiz predefinido.
• Gerenciamento Eficiente de Arquivos: Fornece ferramentas para leitura e busca de arquivos.
• Metadados Detalhados: Recupera metadados abrangentes de arquivos, incluindo tamanho, data de criação, data da última modificação, permissões e tipo.
• Análise de Dependências: Percorre e analisa árvores de dependências dentro de projetos.

📋 Linguagens Suportadas

• JavaScript/TypeScript
• CSS / Pré-processadores CSS

🛠️ Ferramentas

• get-project-basics: Recupera informações essenciais do projeto, incluindo detalhes do package.json e estrutura de diretórios.
• search-config-files: Busca arquivos de configuração dentro do diretório raiz e retorna seus caminhos.
• get-dependency-tree: Percorre a árvore de dependências com base no caminho do arquivo e no diretório raiz fornecidos, e retorna os resultados da travessia.
• list-directory: Lista o conteúdo de um diretório especificado, distinguindo entre arquivos e diretórios.
• read-file-with-metadata: Lê o conteúdo de um arquivo especificado e recupera seus metadados.

🚀 Início Rápido

Pré-requisitos

• Node.js v18 ou posterior
• Codebase para se comunicar com o LLM

Instalação

Primeiro, instale o servidor Codebase MCP com seu cliente. Uma configuração típica é assim:

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest", "/path/to/your/codebase"]
    }
  }
}

Ou você pode instalar o servidor Codebase MCP com Docker.

Após clonar este repositório, crie a imagem Docker:

docker build -t mcp/codebase -f .

E então adicione o seguinte ao seu arquivo de servidores MCP:

{
  "mcpServers": {
    "Codebase": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount",
        "type=bind,src=/path/to/your/codebase/dir,dst=/projects/path/to/your/codebase/dir,ro",
        "--mount",
        "type=bind,src=/path/to/some/file.txt,dst=/projects/path/to/some/file.txt",
        "mcp/codebase",
        "/projects"
      ]
    }
  }
}

Instalar no VS Code Você pode instalar o servidor Codebase MCP usando a CLI do VS Code:

# For VS Code
code --add-mcp '{"name":"Codebase","command":"npx","args":["codebase-mcp-server@latest"]}'

Após a instalação, o servidor Codebase MCP estará disponível para uso com seu agente GitHub Copilot no VS Code.

Instalar no Cursor Vá para Configurações do Cursor -> MCP -> Adicionar novo servidor MCP. Use a seguinte configuração:

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

Instalar no Windsurf

Siga a documentação MCP do Windsurf. Use a seguinte configuração:

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

Instalar no Claude Desktop

Siga o guia de instalação do MCP, use a seguinte configuração:

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

🔧 Build

Build de Desenvolvimento Local

# Install dependencies
npm ci

# Build TypeScript
npm run build

Build Docker

# Build Docker image
docker build -t mcp/codebase -f .

# Or with specific tag
docker build -t mcp/codebase:latest -f .

🤝 Contribuição

Contribuições são bem-vindas! Por favor, leia nosso Guia de Contribuição para detalhes sobre nosso Código de Conduta e o processo para envio de pull requests.