项目简介

Fuel文档搜索MCP服务器是一个基于Model Context Protocol (MCP) 构建的后端应用,旨在为Fuel Network和Sway语言开发者提供高效的文档搜索能力。通过集成到IDE(如Cursor),开发者可以利用语义搜索快速查找Fuel和Sway相关的文档,从而加速开发流程。

主要功能点

  • 文档索引与管理: 自动索引Fuel和Sway的Markdown文档,存储到Qdrant向量数据库中。
  • 语义搜索: 支持通过自然语言查询文档,利用向量数据库和嵌入模型实现高效的语义搜索。
  • MCP工具: 通过MCP协议提供 'searchFuelDocs' 工具,允许MCP客户端(如IDE插件)调用文档搜索功能。
  • 开箱即用: 提供Docker Compose配置,一键启动Qdrant数据库和MCP服务器。

安装步骤

  1. 安装 Qdrant 数据库: 推荐使用 Docker 快速安装 Qdrant。

    docker pull qdrant/qdrant
  2. 克隆仓库: 将 'fuel-mcp-server' 仓库克隆到本地。

    git clone https://github.com/FuelLabs/fuel-mcp-server
    cd fuel-mcp-server
  3. 安装依赖: 使用 'bun' 安装项目依赖。

    bun install
  4. 启动 Qdrant (可选,如果已安装可跳过): 可以使用 Docker Compose 启动 Qdrant 和 MCP 服务器,或者手动启动 Qdrant。

    • 使用 Docker Compose (推荐): 在仓库根目录下,运行以下命令启动 Qdrant 和 MCP 服务器。
      docker compose up --build -d
    • 手动启动 Qdrant: 如果选择手动安装和运行 Qdrant,请确保 Qdrant 服务已启动并运行在 'http://localhost:6333'。
  5. 索引文档: 运行索引脚本将 Markdown 文档索引到 Qdrant 数据库中。

    • 默认索引: 索引 './docs' 目录下的文档。
      bun run src/indexer.ts
    • 自定义索引: 可以指定文档目录、集合名称和模型名称。
      bun run src/indexer.ts <文档目录> <集合名称> <模型名称>
      例如:
      bun run src/indexer.ts ./my-docs my_fuel_docs Xenova/bge-small-en-v1.5

服务器配置

为了让MCP客户端(如Cursor)连接到 Fuel文档搜索MCP服务器,需要在客户端的MCP服务器配置中添加以下JSON配置。

{
  "servers": {
    "fuel-docs-search": {
      "command": "bun",
      "args": [
        "{your-repo-path}/dist/src/mcp-server.js"
      ]
    }
  }
}
  • servers: MCP服务器配置列表。
  • fuel-docs-search: 自定义的服务器名称,在客户端中用于标识该服务器。
  • command: 启动MCP服务器的命令,这里使用 'bun' 运行 JavaScript 文件。
  • args: 命令参数,指向编译后的 'mcp-server.js' 文件路径。请将 '{your-repo-path}' 替换为 'fuel-mcp-server' 仓库在您本地的绝对路径

注意: 如果使用 Docker Compose 运行,可以使用以下 'stdio' 命令连接 (需要在Cursor的MCP配置中选择 "stdio" 类型并填入以下 command 和 cwd 字段):

{
  "servers": [
    {
      "name": "Fuel MCP Server (Docker)",
      "type": "stdio",
      "command": "docker compose exec -T mcp-server-app bun run mcp-server",
      "cwd": "{your-repo-path}" //  **请将 '{your-repo-path}' 替换为 'fuel-mcp-server' 仓库在您本地的绝对路径**
    }
  ]
}

基本使用方法

  1. 启动 MCP 服务器: 确保 Qdrant 数据库已运行,然后根据上述服务器配置启动 MCP 服务器。如果使用 Docker Compose,服务器已随 Qdrant 一同启动。

  2. 在 MCP 客户端中使用: 在支持 MCP 协议的客户端(如 Cursor)中配置并连接到 Fuel文档搜索MCP服务器。连接成功后,即可在客户端中使用 'searchFuelDocs' 工具进行文档搜索。 例如,在 Cursor 中,你可以通过聊天或者代码操作调用 'searchFuelDocs' 工具,输入查询内容,即可获取 Fuel 和 Sway 文档的搜索结果。

信息

分类

开发者工具