关键词

依赖文档提取API文档软件依赖文档生成开发工具

使用说明

项目简介

Daipendency MCP服务器是一个基于Model Context Protocol (MCP) 的后端应用，旨在为LLM客户端提供项目依赖的文档提取功能。它通过标准化的MCP协议与客户端通信，提供工具调用能力，帮助LLM理解和利用项目依赖的上下文信息。

主要功能点

  • 依赖文档提取: 提供 'get_dependency_docs' 工具，用于提取指定项目依赖的叙述性文档和API文档。
  • MCP协议支持: 基于 '@modelcontextprotocol/sdk' 实现，遵循MCP协议规范，可与任何兼容MCP协议的客户端进行交互。
  • Stdio传输: 使用标准输入输出 (Stdio) 作为默认的传输协议，方便快速部署和集成。
  • 工具注册与执行: 支持注册和执行工具，允许LLM客户端通过调用工具来扩展其能力。
  • 错误处理: 提供错误处理机制，当工具执行出错时，能够向客户端返回包含错误信息的响应。

安装步骤

  1. 确保已安装 Node.js 和 npm (或 npx)。
  2. 使用以下命令即可运行 Daipendency MCP 服务器： 
    npx -y @daipendency/mcp
    该命令会自动下载并执行 Daipendency MCP 服务器。

服务器配置

对于 MCP 客户端，需要配置以下信息以连接到 Daipendency MCP 服务器。以下是 JSON 格式的配置信息示例，请根据您的 MCP 客户端进行相应配置：

{
  "serverName": "Daipendency",
  "command": "npx",
  "args": ["-y", "@daipendency/mcp"]
}

配置参数说明:

  • 'serverName': 服务器名称，设置为 "Daipendency"。
  • 'command': 启动服务器的命令，设置为 "npx"。
  • 'args': 启动服务器命令的参数，设置为 '["-y", "@daipendency/mcp"]'。 '-y' 参数用于跳过 'npx' 的安装确认提示。'@daipendency/mcp' 指定要执行的 npm 包。

基本使用方法

  1. 启动 Daipendency MCP 服务器 (按照安装步骤执行 'npx -y @daipendency/mcp')。服务器将通过 Stdio 监听来自 MCP 客户端的请求。

  2. 在 MCP 客户端中，配置连接到 Daipendency MCP 服务器。

  3. 客户端可以使用 'get_dependency_docs' 工具，并提供以下参数：

    • 'name': 要提取文档的依赖项名称 (字符串类型)。
    • 'dependant_path': 依赖项目录的绝对路径 (字符串类型)。

    例如，客户端可以发送 JSON-RPC 请求调用 'get_dependency_docs' 工具，以获取指定依赖项的文档内容。服务器将返回包含文档内容的 JSON-RPC 响应。

注意:

  • 当前版本仅支持提取 Rust 项目的依赖文档。
  • 'dependant_path' 必须是本地项目目录的绝对路径。

信息

分类

开发者工具

访问项目