使用说明（Markdown 格式）

• 项目简介

  • ts-graph-mcp 是一个基于 MCP 的后端服务，能够将一个 TypeScript 代码库的结构和依赖关系抽象成一个图数据库，便于 AI 编码代理通过 MCP 工具进行查询、分析和图形化浏览。
  • 服务器核心职责包括：托管和管理 Resources（代码图中的符号与关系）、注册并执行 Tools（如调用关系、影响分析、路径查找等工具）、定义与渲染 Prompt 模板，提供面向 LLM 的上下文服务。

• 主要功能点

  • 自动索引 TS 代码，提取节点（函数、类、接口、类型、变量等）以及边（调用、导入、包含、类型使用、继承/实现等）并写入图数据库。
  • 提供 6 种 MCP 工具，用于查询图谱（如 incoming/outgoing 调用、包依赖、影响分析、路径查找等），统一以 SymbolQuery 风格输入。
  • 支持会话管理、能力声明，以及多传输协议支持（如 Stdio、SSE、WebSocket 等）。
  • 具备示例化的多项目/多模块配置，便于在不同 TS 项目上建立 MCP 服务。

• 安装步骤

  • 确保 Node.js 版本符合项目要求（文档/示例中使用 Node 18+）。
  • 在目标仓库根目录执行安装命令以获取依赖。
  • 按照 Quick Start 的示例准备 ts-graph-mcp.config.* 配置文件，定义模块与包信息。
  • 启动服务器：在命令行执行 npx ts-graph-mcp 即可启动 MCP 服务器。

• 服务器配置（用于 MCP 客户端连接的 JSON 配置）

  • serverName: 指定服务器名称，用于在客户端区分不同 MCP 服务实例。
  • command: 启动服务器所使用的命令，一般为 npx。
  • args: 启动命令的参数，通常为 ["ts-graph-mcp"]。
  • 传输与端口等其他配置（如需要通过 SSE/WebSocket/StdIO 连接）可在后续扩展字段中配置。
  • 示例配置（描述性信息，不含代码块）：
    • serverName: "ts-graph-mcp"
    • command: "npx"
    • args: ["ts-graph-mcp"]
    • transports: ["stdio", "sse", "websocket"]

• 基本使用方法

  • 启动后，服务器进入 MCP 标准交互模式，客户端通过 JSON-RPC 请求读取资源、调用工具、获取 Prompts 等。
  • 客户端可通过 MCP 提供的工具集进行代码图谱查询、影响分析、路径查询等操作，以实现对代码库的结构化理解与推理支持。
  • 使用文档中的示例与样例项目（如 monorepo、web-app、layered-api、references、call-chain 等）来快速了解工具输出格式及查询用法。

• 重要提示

  • MCP 客户端不需要服务器端的实现细节（如内部 CLI 细节），只需要服务器暴露的启动命令和连接配置即可。
  • 如需扩展，服务器端应继续完善对更多传输协议的支持、权限/认证、会话管理等能力。