代码索引与理解服务器

Codex MCP Server 是一个本地仓库索引和代码理解的模型上下文协议服务器,提供语义代码搜索、AST分析、实时索引等功能。

  • by hailangx
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 hailangx/codex-mcp-server

使用说明

Codex MCP服务器

用于本地存储库索引和代码理解的模型上下文协议(MCP)服务器。

特性

  • 🔍 语义代码搜索:在整个代码库中进行基于矢量的搜索
  • 🏗️ AST分析:使用Tree sitter深入理解代码结构
  • 📊 实时索引:增量更新的文件系统监控
  • 🔗 依赖项跟踪:导入/导出关系映射
  • 🎯 符号分辨率:查找定义、引用和用法
  • 🚀 VS代码集成:与编码代理无缝集成

建筑

┌─── MCP Server ───────────────────────────────────────┐
│  ├── Tools (search_code, find_symbol, etc.)         │
│  ├── Database Layer (SQLite + Vector Storage)       │
│  ├── Indexing Engine (AST + Embeddings)             │
│  ├── File System Monitor (Real-time updates)        │
│  └── Language Parsers (TypeScript, Python, etc.)   │
└─────────────────────────────────────────────────────┘

📋 设计文档:在进行架构更改之前,请查看 design/ 文件夹:

安装

npm install
npm run build

发展

npm run dev

用法

在MCP客户端中配置(例如,VS Code):

{
  "mcpServers": {
    "codex": {
      "command": "node",
      "args": ["path/to/codex-mcp-server/dist/index.js"],
      "env": {
        "REPO_PATH": "/path/to/your/repository"
      }
    }
  }
}

可用工具

  • search_code -跨代码库的语义搜索
  • find_symbol -查找函数/类定义
  • get_references -查找所有符号用法
  • analyze_dependencies -显示导入/依赖关系图
  • get_context -获取代码理解的相关上下文
  • index_repository -手动触发存储库索引

配置

设置环境变量:

  • REPO_PATH -要索引的存储库路径
  • OPENAI_API_KEY -用于嵌入生成(可选,可以使用本地嵌入)
  • DB_PATH -数据库存储路径(默认:./data)

🤖 GitHub复制集成

该项目旨在与GitHub Copilot编码代理无缝协作。有关使用GitHub Copilot的详细实现说明,请参阅 GITHUB_PILOT_GUIDE.md.

GitHub Copilot快速入门

  1. 使用标签触发器:添加 #github-pull-request_copilot-coding-agent 根据您的要求
  2. 提供清晰的上下文:“使用SQLite集成实现DatabaseManager类以进行代码索引”
  3. 参考架构:指向现有的接口和类型以实现一致的实现
  4. 增量测试:在实现时构建和测试每个组件

副驾驶提示示例

Implement the LanguageParser class that can parse JavaScript and TypeScript files 
to extract function definitions, class declarations, and import statements.
#github-pull-request_copilot-coding-agent
Create comprehensive unit tests for the SearchEngine class, focusing on semantic 
search functionality and vector similarity calculations.
#github-pull-request_copilot-coding-agent

有关完整的实现指南、分阶段说明以及将GitHub Copilot与此代码库一起使用的最佳实践,请参阅 GitHub复制指南.

许可证

麻省理工学院