<img alt="在 VS Code 中安装 (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=plastic&label=Install&color=0098FF">
<img alt="在 VS Code Insiders 中安装 (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=plastic&label=Install&color=24bfa5">
<img alt="在 Cursor 中安装 (npx)" src="https://img.shields.io/badge/Cursor-Cursor?style=plastic&label=Install&color=1A1A1A">
这是一个用于 Specifai 项目集成和自动化的 Model Context Protocol (MCP) 服务器。该服务器设计为工具无关,意味着它可以与任何支持 MCP 协议的工具一起使用。当前,此服务器暴露了读取由 Specifai 项目生成的所有文档的工具。
[!警告] 此服务器目前处于实验阶段。功能和可用工具可能会随着我们继续开发和改进服务器而发生变化和扩展。
# 最新版本
npx --yes @presidio-dev/specifai-mcp-server@latest
# 指定版本
npx --yes @presidio-dev/specifai-mcp-server@1.2.3
我们推荐使用 npx 来安装服务器,但您也可以使用任何您喜欢的 Node 包管理器,如 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,那么 .specifai-path 文件应包含以下内容:
/path/to/project
查看每个设置说明
<details> <summary><b>在 Hai Build 中安装</b></summary>在您的 hai_mcp_settings.json 文件中添加以下内容。要从 Hai Build 打开此文件,请点击“MCP 服务器”图标,选择“已安装”选项卡,然后点击“配置 MCP 服务器”。
更多信息请参阅 Hai Build MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
</details>
<details>
<summary><b>在 Amazon Q Developer 中安装</b></summary>
在您的 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"]
}
}
}
</details>
<details>
<summary><b>在 VS Code (Copilot) 中安装</b></summary>
<img alt="在 VS Code 中安装 (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=plastic&label=Install&color=0098FF"> <img alt="在 VS Code Insiders 中安装 (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=plastic&label=Install&color=24bfa5">
首先,在 VS Code 中启用 MCP 支持:打开设置 (Ctrl+,),搜索 mcp.enabled 并勾选框。
然后,在您的用户或工作区 settings.json 文件中添加以下配置。更多信息请参阅 VS Code MCP 文档。
"mcp": {
"servers": {
"specifai": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
</details>
<details>
<summary><b>在 Cursor 中安装</b></summary>
最简单的安装方式是使用下面的一键安装按钮。
或者,您可以通过在 mcp.json 文件中添加以下内容手动配置服务器。此文件可以全局存储在 ~/.cursor/mcp.json,或者在特定项目中的 .cursor/mcp.json。更多信息请参阅 Cursor MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
</details>
<details>
<summary><b>在 Windsurf 中安装</b></summary>
在您的 ~/.codeium/windsurf/mcp_config.json 文件中添加以下内容。更多信息请参阅 Windsurf MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
</details>
<details>
<summary><b>在 Zed 中安装</b></summary>
您可以在 Zed 中通过编辑 settings.json 文件(可通过 zed: settings 动作访问)或使用代理面板的配置界面(agent: open configuration)添加 Specifai MCP 服务器。更多信息请参阅 Zed MCP 文档。
在您的 settings.json 中添加以下内容:
{
"context_servers": {
"specifai": {
"command": {
"path": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
}
</details>
服务器提供了多个工具来与您的规范文档进行交互:
| 工具名称 | 描述 |
|---|---|
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 许可证 - 详情请参阅 LICENSE 文件。