Índice de código MCP

Code Index MCP es un servidor de protocolo de contexto de modelo que permite que los modelos de lenguaje grandes (LLM) indexen, busquen y analicen código en directorios de proyectos.

Características

• Indexar y navegar por las estructuras de archivos del proyecto
• Buscar patrones específicos en el código
• Obtenga resúmenes detallados de archivos
• Analizar la estructura y la complejidad del código
• Soporte para múltiples lenguajes de programación
• Almacenamiento persistente de la configuración del proyecto

Instalación

Este proyecto utiliza uv para la gestión del entorno y la instalación de dependencias.

1. Asegúrese de tener instalado Python 3.10 o posterior
2. Instalar uv (recomendado):
   # Windows powershell -c "irm https://astral.sh/uv/install.ps1 | iex" # macOS/Linux curl -LsSf https://astral.sh/uv/install.sh | sh
3. Obteniendo el código:
   # Clone the repository git clone https://github.com/your-username/code-index-mcp.git

Uso

Ejecutar el servidor directamente

UV manejará automáticamente todas las instalaciones de dependencias según la configuración del proyecto.

Integración con Claude Desktop

Puede integrar fácilmente Code Index MCP con Claude Desktop:

1. Asegúrese de tener instalado el sistema UV (consulte la sección de instalación más arriba)
2. Busque o cree el archivo de configuración de Claude Desktop:
   • Ventanas: %APPDATA%\Claude\claude_desktop_config.json
   • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
3. Agregue la siguiente configuración (reemplácela con su ruta real):Para Windows :
   { "mcpServers": { "code-indexer": { "command": "uv", "args": [ "--directory", "C:\\Users\\username\\path\\to\\code-index-mcp", "run", "run.py" ] } } }
   Para macOS/Linux :
   { "mcpServers": { "code-indexer": { "command": "uv", "args": [ "--directory", "/home/username/path/to/code-index-mcp", "run", "run.py" ] } } }
   Nota : La opción --directory es importante ya que garantiza que uv se ejecute en el directorio de proyecto correcto y pueda cargar correctamente todas las dependencias.
4. Reinicie Claude Desktop para usar Code Indexer para analizar proyectos de código

No se requiere la instalación manual de dependencias: UV manejará automáticamente todas las dependencias al ejecutar el servidor.

Flujo de trabajo básico

1. Establecer la ruta del proyecto (primer paso obligatorio):
   • Al utilizarlo por primera vez, debe configurar la ruta del proyecto para analizarlo
   • A través del comando de Claude: "Necesito analizar un proyecto, ayúdenme a definir la ruta del proyecto"
   • Proporcione la ruta completa del directorio del proyecto
2. Búsqueda de código :
   • Buscar palabras clave o patrones específicos: "Buscar 'nombre de función' en el proyecto"
   • Filtrar por tipo de archivo: "Buscar 'importar' en todos los archivos .py"
3. Análisis de archivos :
   • Analizar archivos específicos: "Analizar el archivo src/main.py"
   • Obtener resúmenes de archivos: "Dame una lista de funciones en utils/helpers.js"
4. Navegación del proyecto :
   • Ver la estructura del proyecto: "Muéstrame la estructura de este proyecto"
   • Buscar archivos que coincidan con patrones específicos: "Buscar todos los archivos test_*.py"

Detalles técnicos

Almacenamiento persistente

Todos los datos de índice y configuración se almacenan en la carpeta .code_indexer dentro del directorio del proyecto:

• config.json : Información de configuración del proyecto
• file_index.pickle : Datos del índice del archivo
• content_cache.pickle : caché de contenido de archivos

Esto garantiza que no sea necesario volver a indexar todo el proyecto cada vez que se utiliza.

Gestión de dependencias con UV

Code Index MCP utiliza UV para la gestión de dependencias, lo que proporciona varias ventajas:

• Resolución automática de dependencias según los requisitos del proyecto
• Instalación de paquetes y configuración del entorno más rápidas
• Versiones de dependencia consistentes a través del archivo de bloqueo

Tipos de archivos admitidos

Actualmente se admiten los siguientes tipos de archivos para la indexación y el análisis:

• Python (.py)
• JavaScript/TypeScript (.js, .ts, .jsx, .tsx)
• Java (.java)
• C/C++ (.c, .cpp, .h, .hpp)
• C# (.cs)
• Ir (.go)
• Rubí (.rb)
• PHP (.php)
• Swift (.swift)
• Kotlin (.kt)
• Óxido (.rs)
• Scala (.scala)
• Shell (.sh, .bash)
• HTML/CSS (.html, .css, .scss)
• Markdown (.md)
• JSON (.json)
• XML (.xml)
• YAML (.yml, .yaml)

Consideraciones de seguridad

• La validación de la ruta de archivo evita ataques de recorrido de directorio
• No se permite el acceso a la ruta absoluta
• La ruta del proyecto debe establecerse explícitamente, sin un valor predeterminado
• La carpeta .code_indexer incluye un archivo .gitignore para evitar que se confirmen los datos de indexación

Contribuyendo

Las contribuciones a través de problemas o solicitudes de extracción para agregar nuevas características o corregir errores son bienvenidas.

Para obtener la documentación en chino, consulte README_zh.md .