CodeCortex MCP 服务器

使用说明(Markdown 格式)

  • 项目简介 CodeCortex 实现了一个基于 MCP 的后端服务器,旨在以标准化的 JSON-RPC 风格向 LLM 客户端提供代码库上下文与功能访问。核心功能包括:托管资源(Resources)、注册和执行工具(Tools)、定义和渲染 Prompt 模板(Prompts),并通过多传输协议(如 StdIO)与客户端通信。服务器还负责会话管理、能力声明,并对知识进行分层(六大知识层、模块文档、-temporal 数据等)以便高效地为 AI 提供上下文。

  • 主要功能点

    • MCP 服务器实现与暴露的工具集合
      • 8 种读取工具(如获取项目概览、模块上下文、会话摘要、知识检索、依赖关系等)
      • 5 种写入工具(如记录决策、更新模式、记录观察、写模块文档、更新模式等)
    • 资源托管与访问:将分析结果(模块文档、符号索引、图等)持久化在 .codecortex 目录下,供 MCP 客户端查询
    • 提供多种传输方式(当前实现以 StdIO 为 MCP 服务传输)
    • 会话管理、版本与 freshness(新鲜度)评估、降噪与裁剪输出以确保上下文安全与高效
    • 与现有树状结构的代码分析、符号提取、图谱生成、时序分析等模块深度整合
  • 安装步骤

    1. 安装 CodeCortex(全局或项目本地安装):
      • 通过 npm 全局安装:npm install -g codecortex-ai
    2. 在你的代码库根目录初始化知识并生成 MCP 可用的知识存储(示例命令,需在实际项目中执行):
      • codecortex init
      • codecortex serve 用以启动 MCP 服务器(标准输入输出传输)
    3. 连接 MCP 客户端
      • Claude Code / Cursor 等工具通过 MCP 配置连接到服务器(见下方“服务器配置”示例)
  • 服务器配置(MCP 客户端需提供的连接信息;以下为可参考的 JSON 配置说明,非可执行代码) { "serverName": "codecortex", "command": "codecortex", "args": ["serve"], "cwd": "/path/to/your-project" // 服务器所在工作目录,需指向含有 cortex.yaml 的代码库根路径 // 说明:client 通过该信息启动 codecortex serve 来建立 MCP 连接 }

  • 基本使用方法

    • 启动服务器:在代码库根目录执行 codecortex serve;服务将通过标准输入/输出与 MCP 客户端通信
    • 客户端使用顺序(典型工作流)
      1. 读取项目概览与依赖图,获取初始知识背景
      2. 按需查询模块上下文、符号索引、变更历史等,逐步获得所需上下文
      3. 使用写入工具记录重要决策、模式等以增强跨会话的知识积累
      4. 使用搜索、依赖图、模块文档等工具进行深入查询
    • 运行环境要求
      • Node.js 20+(MCP 服务端实现使用 TypeScript/Node.js)
      • 依赖的 tree-sitter 语言包与 MCP SDK 已经在项目中配置好

服务器信息