模型上下文协议服务器

用于Specifai项目集成和自动化的模型上下文协议(MCP)服务器,支持与任何兼容MCP协议的AI工具集成。

  • by presidio-oss
  • TypeScript
  • 本地部署
  • 13 星标
  • 更新于
在 GitHub 查看 presidio-oss/specifai-mcp-server

使用说明

Specifai MCP服务器

一种模型上下文协议(MCP)服务器 指定 与任何兼容MCP的AI工具进行项目集成和自动化。此服务器被设计为与工具无关,这意味着它可以与支持MCP协议的任何工具一起使用。此服务器当前公开了读取Specifai项目生成的所有文档的工具。

[!警告] 此服务器目前处于试验阶段。随着我们不断开发和改进服务器,功能和可用工具可能会发生变化和扩展。

目录

需求

  • Node.js>=16.0.0
  • Bun>=1.0.0(如果使用Bun运行时)
  • Hai Build、Cursor、Windsurf、Claude Desktop或任何MCP客户端

安装

# Latest version
npx --yes @presidio-dev/specifai-mcp-server@latest

# Specific version
npx --yes @presidio-dev/specifai-mcp-server@1.2.3

我们建议 npx 安装服务器,但您可以使用您偏好的任何节点包管理器,例如 yarn, pnpm, bun等等。

配置

随着 npx 最新版本:

{
  "specifai": {
    "command": "npx",
    "args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"],
    "disabled": false,
    "autoApprove": []
  }
}

随着 npx 特定版本:

{
  "specifai": {
    "command": "npx",
    "args": ["--yes", "@presidio-dev/specifai-mcp-server@1.2.3"],
    "disabled": false,
    "autoApprove": []
  }
}

准备你的项目

这是完全可选的,但建议使用它来避免每次访问服务器时都必须指定项目目录路径。对于AI IDE/扩展(Hai Build),建议使用 .specifai-path 文件以指定项目目录路径。

确保您的项目根目录包含 .specifai-path 文件。这就是Specifai MCP服务器如何知道在哪里可以找到Specifai生成的规范文档。

该文件是一个纯文本文件,包含存储项目规范文档的项目目录的绝对路径。

例如,如果您的项目目录位于 /path/to/project,the .specifai-path 文件应包含以下行:

/path/to/project

Specificfai MCP与流行IDE和扩展的集成

请参阅每个的设置说明

Install in Hai Build

将以下内容添加到您的 hai_mcp_settings.json 文件。要从Hai Build打开此文件,请单击“MCP服务器”图标,选择“已安装”选项卡,然后单击“配置MCP服务器”。

请参阅 Hai Build MCP文件 了解更多信息。

{
  "mcpServers": {
    "specifai": {
      "command": "npx",
      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
    }
  }
}
Install in Amazon Q Developer

将以下内容添加到您的Amazon Q Developer配置文件中。看 IDE中Q Developer的MCP配置 了解更多详情。

配置文件可以全局存储在 ~/.aws/amazonq/mcp.json 可在您的所有项目中使用,或在您的项目中本地使用 .amazonq/mcp.json.

{
  "mcpServers": {
    "specifai": {
      "command": "npx",
      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
    }
  }
}
Install in VS Code (Copilot)

首先,通过打开设置在VS代码中启用MCP支持(Ctrl+,),搜索 mcp.enabled,并勾选复选框。

然后,将以下配置添加到您的用户或工作区 settings.json 文件。请参阅 VS代码MCP文档 了解更多信息。

"mcp": {
  "servers": {
    "specifai": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
    }
  }
}
Install in Cursor

最简单的安装方法是单击下面的安装按钮。

或者,您可以通过将以下内容添加到您的 mcp.json 文件。此文件可以全局定位在 ~/.cursor/mcp.json 或在特定项目中 .cursor/mcp.json。请参阅 光标MCP文档 了解更多信息。

{
  "mcpServers": {
    "specifai": {
      "command": "npx",
      "args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"]
    }
  }
}
Install in Windsurf

将以下内容添加到您的 ~/.codeium/windsurf/mcp_config.json 文件。请参阅 Windsurf MCP文件 了解更多信息。

{
  "mcpServers": {
    "specifai": {
      "command": "npx",
      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
    }
  }
}
Install in Zed

您可以通过编辑您的 settings.json 文件(可通过 zed: settings 操作)或使用代理面板的配置UI(agent: open configuration).请参阅 Zed MCP文件 了解更多信息。

将以下内容添加到您的 settings.json:

{
  "context_servers": {
    "specifai": {
      "command": {
        "path": "npx",
        "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
      }
    }
  }
}

可用工具

服务器提供了几个与规范文档交互的工具:

工具名称 描述
get-brds 获取业务需求文档
get-prds 获取产品需求文档
get-nfrs 获取非功能需求
get-uirs 获取用户界面需求
get-bpds 获取业务流程文档
get-tcs 获取测试用例文档
get-user-stories 获取特定PRD的用户故事
get-tasks 获取特定用户故事的任务
get-task 获取特定任务的详细信息
set-project-path 设置或更改项目目录路径
get-task-by-id 按ID获取特定任务的详细信息
list-all-tasks 列出所有可用任务
search 在所有文档中进行全文搜索

贡献

我们欢迎对Specifai MCP服务器的贡献!请查看我们的 贡献指南 了解更多关于如何开始的信息。

开发设置

有关设置开发环境的详细说明,请参阅我们的 开发设置指南.

建筑

要了解项目架构,请参阅我们的 架构指南.

安全

有关我们的安全政策以及如何报告安全漏洞的信息,请参阅我们的 安全策略.

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢