项目简介

Ampersand MCP 文档服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务。它提供了一个核心功能:搜索 Ampersand 的官方文档,并将搜索结果以结构化的方式提供给支持MCP协议的大型语言模型(LLM)客户端,如 Cursor IDE 或 Claude Desktop。这使得LLM能够更准确、更高效地回答关于Ampersand集成、API使用或产品功能的问题。

主要功能点

  • 文档搜索工具: 注册并提供一个名为 'searchAmpersand' 的MCP工具,允许LLM客户端通过调用该工具,输入查询关键词,获取Ampersand官方文档中的相关内容。
  • 上下文提供: 将搜索到的文档内容作为上下文信息返回给LLM,增强LLM对Ampersand相关知识的理解和应用能力。
  • MCP协议支持: 实现了MCP服务器端逻辑,通过Stdio或HTTP SSE等传输协议与MCP客户端通信,处理请求和发送响应。

安装步骤

  1. 通过npx直接运行 (推荐本地快速启动): 在终端运行以下命令即可启动服务器,默认运行在 'http://localhost:3001' 并使用 SSE 传输。

    npx @amp-labs/mcp-docs-server@latest
  2. 手动构建和运行: 如果你需要更多控制或进行开发,可以手动克隆仓库、安装依赖并构建:

    • 安装pnpm (如果未安装): 'npm install -g pnpm'
    • 克隆仓库并进入目录:(假设你已克隆) 'cd mcp-docs-server'
    • 安装依赖: 'pnpm i'
    • 构建项目: 'pnpm build'
    • 启动服务器: 'pnpm start' (默认使用 SSE) 或 'pnpm start --transport stdio' (使用 Stdio 传输)

MCP客户端配置

为了让你的MCP客户端(如 Cursor 或 Claude Desktop)连接并使用此服务器,你需要修改客户端的配置文件(例如 'mcp.json' 或 'claude_desktop_config.json')。

配置的目的是告诉客户端如何启动和连接到这个MCP服务器。通常,客户端会配置为通过 Stdio 传输启动本地服务器进程。以下是配置所需的主要信息:

  • 服务器名称 ('server name'): '@amp-labs/mcp-docs-server'
  • 启动命令 ('command'): 用于执行服务器的可执行文件或脚本,例如 'npx'。
  • 命令参数 ('args'): 传递给启动命令的参数列表,通常包含包名和指定传输协议的参数。对于通过 Stdio 启动,参数列表应包含 '@amp-labs/mcp-docs-server@latest', '--transport', 'stdio'。

例如,一个典型的客户端配置文件片段可能看起来像这样(具体格式取决于你的MCP客户端):

{
  "mcpServers": {
    "@amp-labs/mcp-docs-server": {
      "command": "npx",
      "args": ["@amp-labs/mcp-docs-server@latest", "--transport", "stdio"],
      "description": "提供Ampersand文档搜索能力,通过stdio传输连接本地服务"
    }
    // ... 其他服务器配置
  }
}

将此配置添加到你的MCP客户端配置文件中,并按照客户端的说明启用该服务器。

基本使用方法

配置完成后,启动你的MCP客户端。客户端将检测到新的MCP服务器配置并尝试连接。连接成功后,LLM即可通过调用名为 'searchAmpersand' 的工具来搜索Ampersand文档,获取相关信息以辅助编程或解决问题。你可以在与LLM交互时,提出需要Ampersand文档支持的问题,LLM应能自动识别并使用该工具。

信息

分类

开发者工具