FeathersJS文档服务

一个用于发现和读取FeathersJS官方文档的只读MCP服务器。

  • by fedevela
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 fedevela/feathersjs-mcp

使用说明

feathersjs文档mcp

用于发现和读取的只读MCP服务器 FeathersJS文档 来自官方Feathers存储库。


特性

  • 将Feathers文档存储库同步到本地缓存中
  • 索引标记页面来自 docs/
  • 展示MCP工具,用于列表、读取、刷新和状态检查
  • 暴露 feathers-doc://docs/{path} 作为markdown资源模板

MCP工具

  • list_docs(query?, limit?, offset?)
  • read_doc(uri)
  • refresh_docs_index(forceRebuild?)
  • get_docs_status()

安装

npm install

构建

npm run build

运行(本地stdio)

FEATHERS_MCP_TRANSPORT=stdio npm start

测试

npm run test:e2e

本地MCP快速启动

此软件包旨在作为 本地MCP服务器 通过您的MCP客户端。

配置您的MCP客户端以运行此本地构建

{
  "mcpServers": {
    "feathersjs-docs": {
      "command": "node",
      "args": ["/absolute/path/to/feathersjs-mcp/dist/index.js"],
      "env": {
        "FEATHERS_MCP_TRANSPORT": "stdio",
        "FEATHERS_REPO_BRANCH": "dove"
      }
    }
  }
}

先建造(npm run build)所以 dist/index.js 存在,然后重新启动IDE或MCP客户端。


配置

  • FEATHERS_MCP_TRANSPORT (默认值: httpStream,值: stdio | httpStream)
  • FEATHERS_MCP_HTTP_HOST (默认值: 127.0.0.1)
  • FEATHERS_MCP_HTTP_PORT (默认值: 8123)
  • FEATHERS_MCP_HTTP_ENDPOINT (默认值: /mcp)
  • FEATHERS_MCP_HTTP_STATELESS (默认值: false)
  • FEATHERS_REPO_URL (默认值: https://github.com/feathersjs/feathers.git)
  • FEATHERS_REPO_BRANCH (默认值: dove)
  • FEATHERS_MCP_CACHE_DIR (默认值: ./.cache/feathersjs-docs-mcp)
  • TOP_K (默认值: 6)

对于stdio上的本地MCP使用,请设置 FEATHERS_MCP_TRANSPORT=stdio.


MCP客户端配置示例

{
  "mcpServers": {
    "feathers-docs": {
      "command": "node",
      "args": ["/home/bob/feathersjs-docs-mcp/dist/index.js"],
      "disabled": false,
      "autoApprove": [],
      "env": {
        "FEATHERS_REPO_BRANCH": "dove"
      }
    }
  }
}

许可证

麻省理工学院