Codebase MCP Server

Servidor MCP de Codebase

Protocolo de Contexto de Modelo para análisis de Codebase seguro y eficiente

Características Clave • Lenguajes Soportados • Herramientas • Inicio Rápido • Compilación • Contribuciones

🌟 Características Clave

• Acceso Seguro: Restringe las operaciones de archivos al directorio raíz predefinido.
• Gestión Eficiente de Archivos: Proporciona herramientas para leer y buscar archivos.
• Metadatos Detallados: Recupera metadatos completos de archivos, incluyendo tamaño, fecha de creación, fecha de última modificación, permisos y tipo.
• Análisis de Dependencias: Recorre y analiza los árboles de dependencias dentro de los proyectos.

📋 Lenguajes Soportados

• JavaScript/TypeScript
• CSS / Preprocesadores de CSS

🛠️ Herramientas

• get-project-basics: Recupera información esencial del proyecto, incluyendo detalles de package.json y la estructura de directorios.
• search-config-files: Busca archivos de configuración dentro del directorio raíz y devuelve sus rutas.
• get-dependency-tree: Recorre el árbol de dependencias según la ruta de archivo y el directorio raíz proporcionados, y devuelve los resultados del recorrido.
• list-directory: Lista el contenido de un directorio especificado, distinguiendo entre archivos y directorios.
• read-file-with-metadata: Lee el contenido de un archivo especificado y recupera sus metadatos.

🚀 Inicio Rápido

Requisitos Previos

• Node.js v18 o posterior
• Codebase para comunicarse con el LLM

Instalación

Primero, instala el servidor MCP de Codebase con tu cliente. Una configuración típica se ve así:

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

O bien, puedes instalar el servidor MCP de Codebase con Docker.

Después de clonar este repositorio, compila la imagen de Docker:

docker build -t mcp/codebase -f .

Y luego agrega lo siguiente a tu archivo 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 en VS Code Puedes instalar el servidor MCP de Codebase usando la CLI de VS Code:

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

Después de la instalación, el servidor MCP de Codebase estará disponible para usarse con tu agente de GitHub Copilot en VS Code.

Instalar en Cursor Ve a Configuración de Cursor -> MCP -> Agregar nuevo servidor MCP. Usa la siguiente configuración:

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

Instalar en Windsurf

Sigue la documentación de MCP de Windsurf. Usa la siguiente configuración:

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

Instalar en Claude Desktop

Sigue la guía de instalación de MCP, usa la siguiente configuración:

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

🔧 Compilación

Compilación de Desarrollo Local

# Install dependencies
npm ci

# Build TypeScript
npm run build

Compilación con Docker

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

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

🤝 Contribuciones

¡Las contribuciones son bienvenidas! Por favor, lee nuestra Guía de Contribuciones para obtener detalles sobre nuestro Código de conducta y el proceso para enviar solicitudes de extracción.