关于 Specifai MCP Server
Specifai MCP Server 将 Specifai 生成的项目文档提供给兼容 MCP 的 AI 工具,适用于需要查询需求和任务资料的项目团队。它支持按文档类型读取、全文搜索及任务查询;目前处于实验阶段。
主要功能
- 01读取业务与产品需求文档
- 02读取非功能及界面需求
- 03读取业务流程与测试用例
- 04查询用户故事和任务
- 05跨文档全文搜索
适用场景
- 01在 IDE 中查阅项目需求
- 02根据用户故事查看任务
- 03搜索 Specifai 项目文档
- 04按 ID 查询任务详情
MCP 相关
该 MCP 服务向兼容客户端公开 Specifai 文档读取、搜索和任务管理工具,可与 Hai Build、Cursor 等工具集成。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
13收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cwd | string | 是 | 调用工具的绝对路径,且该路径包含 `.specifai-path` 文件,用于自动推断 specifai 项目路径。此路径将作为调用工具时的当前工作目录(cwd)。 |
| includeDescription | boolean | 否 | 在输出中包含描述,默认为 false |
| limit | number | 否 | 限制返回的文档数量,默认为 10 |
| offset | number | 否 | 要返回的文档数量偏移量,默认为 0 |
详细介绍
Specifai MCP 服务
一个用于将 Specifai 项目与任何兼容 MCP 的 AI 工具集成并实现自动化的模型上下文协议(MCP)服务。此服务旨在与工具无关,也就是说,它可以搭配任何支持 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/[email protected]
我们建议使用 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/[email protected]"],
"disabled": false,
"autoApprove": []
}
}
准备项目
这完全是可选的,但建议使用此方法,以免每次访问服务时都必须指定项目目录路径。对于 AI IDE / 扩展(Hai Build),建议使用
.specifai-path文件指定项目目录路径。
请确保项目根目录中包含 .specifai-path 文件。Specifai MCP 服务通过此文件来确定 Specifai 生成的规范文档所在位置。
该文件是一个纯文本文件,其中包含存放项目规范文档的项目目录的绝对路径。
例如,如果你的项目目录位于 /path/to/project,那么 .specifai-path 文件应包含以下一行:
/path/to/project
Specifai 与热门 IDE 和扩展的 MCP 集成
查看各项的设置说明
在 Hai Build 中安装
将以下内容添加到 hai_mcp_settings.json 文件中。要从 Hai Build 打开此文件,请点击“MCP Servers”图标,选择“Installed”选项卡,然后点击“Configure MCP Servers”。
更多信息,请参阅 Hai Build MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
在 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"]
}
}
}
在 VS Code (Copilot) 中安装
首先,在 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"]
}
}
}
在 Cursor 中安装
最简单的安装方式是使用下方的一键安装按钮。
或者,也可以手动配置服务:将以下内容添加到 mcp.json 文件中。该文件可以存放在全局路径 ~/.cursor/mcp.json,也可以存放在特定项目中的 .cursor/mcp.json。更多信息,请参阅 Cursor MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
在 Windsurf 中安装
将以下内容添加到 ~/.codeium/windsurf/mcp_config.json 文件中。更多信息,请参阅 Windsurf MCP 文档。
{
"mcpServers": {
"specifai": {
"command": "npx",
"args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
}
}
}
在 Zed 中安装
你可以通过编辑 settings.json 文件(可通过 zed: settings 操作访问),或使用 Agent 面板的配置界面(agent: open configuration),在 Zed 中添加 Specifai MCP 服务。更多信息,请参阅 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 Server 做出贡献!有关如何开始的更多信息,请参阅我们的贡献指南。
开发环境设置
有关设置开发环境的详细说明,请参阅我们的开发环境设置指南。
架构
要了解项目架构,请参阅我们的架构指南。
安全
有关我们的安全政策以及如何报告安全漏洞的信息,请参阅我们的安全政策。
许可证
本项目采用 MIT 许可证授权,详情请参阅 LICENSE 文件。
致谢
- Model Context Protocol - 本服务实现的协议规范
- Specifai - 本服务集成的项目
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。