AiDex MCP Server

使用说明

• 项目简介 AiDex 是一个基于 MCP 的服务器端实现，专注于代码基的持久化索引、工具（Tools）注册与执行，以及与 LLM 的高效对话协作。通过 MCP 的 JSON-RPC 与客户端通信，客户端可以查询索引、执行工具、获取和渲染 Prompts 等能力，以提升对代码库的上下文访问效率。

• 主要功能点

  1. 资源托管与数据访问：对代码项目中的文件、签名、签名方法、类型等进行索引与管理，支持跨文件的快速查询与检索。
  2. 工具注册与执行：提供 27 种工具（如 init, query, signature, tree, snapshot 等等），允许 LLM 调用外部功能来完成索引、查询、摘要、全局搜索等任务。
  3. Prompt/描述模板：支持描述、摘要、文件树、签名输出等输出形式，便于将结构化信息呈现给 LLM 客户端。
  4. MCP 协议实现：通过 MCP 的 JSON-RPC 处理工具列表查询和工具调用等请求，响应格式为标准的 MCP 响应。
  5. 会话与全局能力：具备会话管理、全局索引、跨项目查询（全局数据库、ATTACH/跨库查询）等能力，便于多项目协作与大规模代码库的查询。
  6. 传输协议与 UI：默认通过标准输入输出（stdio）与 MCP 客户端对接，且内置查看器、进度展示等辅助工具，提升开发与运维体验。

• 安装步骤

  1. 确保系统安装了 Node.js 18 及以上版本。
  2. 下载或克隆仓库并安装依赖：在项目根目录执行 npm install。
  3. 构建与运行：执行构建后通过 node build/index.js 启动 MCP 服务器。默认会监听标准输入输出传输并启动 MCP 服务。

• 服务器配置（MCP 客户端需要的配置说明） MCP 客户端需要将 AiDex 服务器注册为一个 MCP 服务。配置示例（JSON，描述性文本，不是代码块）：

  • 服务名称（server name）: aidex
  • 启动命令（command）: aidex
  • 启动参数（args）: 空数组或根据实际运行环境添加，例如 []，若有环境变量需在 env 中配置 说明：AiDex 的 MCP 服务器默认使用 stdio 传输，因此在客户端配置中应将 type 设置为 stdio，并将 command 设置为上述启动命令。客户端不需要修改实现细节，只需指向该命令即可建立对话能力。

• 基本使用方法

  1. 启动服务器：在命令行执行 node build/index.js，默认启动 AiDex 的 MCP 服务器。
  2. 使用 MCP 客户端连接：按照客户端文档，将 aidex 作为一个 MCP 服务注册到客户端（通过 type、command、args 等信息）。
  3. 调用工具：通过 MCP 客户端触发工具查询（如 aidex_query、aidex_signature 等），AiDex 将以标准化的 JSON-RPC 响应返回结果。
  4. 结合任务与全局能力：AiDex 提供跨项目查询、全局索引等能力，适用于多仓库的代码检索与分析场景。
  5. 观察与调试：AiDex 提供日志和进度视图（如进度服务器等）以协助运维和调试。

• 运行后可用性 该仓库实现了 MCP 服务器核心逻辑（包括工具注册、工具调用、以及对 MCP 请求的处理），并提供了可执行的服务器入口、命令行工具、以及完整的工具集定义，属于可运行且功能明确的 MCP 服务器实现。