Specif Ai MCP Server

🚀 @vj-presidio/specif-ai-mcp-server 项目文档

本项目提供了一个服务器工具，可用于管理和获取项目中的各种规范性文档，如商业需求文档、产品需求文档等。通过简单的命令行工具，用户可以轻松地设置项目路径、获取所需文档。

🚀 快速开始

本项目提供了多种安装方式，你可以根据自己的需求进行选择。安装完成后，即可使用工具来管理项目文档。

📦 安装指南

使用 curl 或 PowerShell 进行二进制安装

在 Unix 系统上使用 curl：

curl -L https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-linux-amd64.tar.gz | tar xz && chmod +x specif-ai-mcp-server

在 Windows 系统上使用 PowerShell：

(New-Object System.Net.WebClient).DownloadFile('https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-win-amd64.zip', 'specif-ai-mcp-server.zip')
Expand-Archive specif-ai-mcp-server.zip

使用 npm 进行安装

npm install -g @vj-presidio/specif-ai-mcp-server

💻 使用示例

项目路径设置示例

一旦服务器开始运行，您可以通过 set-project-path 工具来设定项目的文件夹路径。这个工具接受一个包含规范性文件的目录路径作为参数。设定路径后，服务器将加载该目录中的所有文档。

{
  "name": "set-project-path",
  "arguments": {
    "path": "./path/to/project"
  }
}

📚 详细文档

可用工具列表

项目路径设置指南

步骤一：下载并安装工具

根据您的操作系统选择合适的安装方式：

• Linux/MacOS: 使用 curl 命令下载并解压二进制文件：

curl -L https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-linux-amd64.tar.gz | tar xz && chmod +x specif-ai-mcp-server

• Windows: 使用 PowerShell 下载并解压二进制文件：

(New-Object System.Net.WebClient).DownloadFile('https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-win-amd64.zip', 'specif-ai-mcp-server.zip')
Expand-Archive specif-ai-mcp-server.zip

步骤二：启动服务器

安装完成后，在终端或命令提示符中运行以下命令启动服务器：

specif-ai-mcp-server start

步骤三：设置项目路径

使用 set-project-path 工具来指定包含规范性文件的目录。例如，将项目路径设为 ./specs:

specif-ai-mcp-server set-project-path --path ./specs

验证配置

启动服务器后，您可以运行以下命令来验证是否正确加载了项目中的文档：

specif-ai-mcp-server get-brds

附加说明

• 帮助信息: 查看工具的帮助信息，请使用以下命令：

specif-ai-mcp-server --help

• 版本信息: 显示当前工具的版本信息：

specif-ai-mcp-server --version

集成与扩展

支持的开发环境

1. Cline
2. Cursor

📄 许可证

本项目遵循 MIT 协议，具体内容请参考项目的 LICENSE 文件。