关键词

需求管理规范文档上下文服务LLM应用开发工具

Specif-ai MCP Server 使用说明

项目简介

Specif-ai MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为 LLM 应用提供结构化规范文档的上下文信息服务。它允许用户通过标准化的 MCP 协议，方便地访问和查询存储在特定项目目录下的需求文档（如 BRD、PRD、NFR、UIR、BP 等）。该服务器通过命令行界面运行，并使用 stdio (标准输入/输出) 进行通信，易于集成到各种 LLM 客户端和开发环境中。

主要功能点

  • 资源管理 (Resources): 托管和管理项目目录下的结构化规范文档，支持多种文档类型 (BRD, PRD, NFR, UIR, BP)。
  • 数据访问能力: 提供工具 (Tools) 以查询和检索文档信息，例如获取特定类型的文档列表、用户故事、任务等。
  • 工具注册和执行 (Tools): 内置多个预定义工具，允许 LLM 客户端通过 MCP 协议调用这些工具来访问文档数据。
  • 标准 MCP 协议: 基于 JSON-RPC over stdio 实现 MCP 协议，确保与兼容 MCP 客户端的互操作性。
  • 灵活安装方式: 支持二进制文件直接安装和包管理器 (npm, bun) 全局安装，满足不同用户的需求。
  • 自动项目路径推断: 能够根据当前工作目录 (cwd) 自动推断项目路径，简化配置。

安装步骤

1. 二进制文件直接安装 (推荐)

这种方式无需 Node.js 或 Bun 环境，安装简便。

Unix (macOS/Linux): 打开终端并执行以下命令：

curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.sh | sh

或者安装特定版本，例如 '1.2.3':

curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.sh | sh -s -- -v 1.2.3

Windows (PowerShell): 打开 PowerShell 并执行以下命令：

iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.ps1 | iex

或者安装特定版本，例如 '1.2.3':

iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.ps1 | iex -v 1.2.3

2. 包管理器全局安装

如果您的环境已安装 Node.js 或 Bun，可以使用包管理器进行全局安装。

npm:

# 最新版本
npm install -g @vj-presidio/specif-ai-mcp-server@latest
# 特定版本，例如 1.2.3
npm install -g @vj-presidio/[email protected]

bun:

# 最新版本
bun install -g @vj-presidio/specif-ai-mcp-server@latest
# 特定版本，例如 1.2.3
bun install -g @vj-presidio/[email protected]

服务器配置

MCP 客户端需要配置启动 Specif-ai MCP Server 的命令和参数。以下是一些常用的配置示例，您可以根据您的安装方式选择合适的配置，并将其添加到您的 MCP 客户端配置中。

1. 使用 'npx' 启动 (无需全局安装，推荐用于测试):

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

或者指定版本:

{
  "specif-ai": {
    "command": "npx",
    "args": ["--yes", "@vj-presidio/[email protected]"],
    "disabled": false,
    "autoApprove": []
  }
}
  • 'command': 指定启动服务器的命令为 'npx' (Node Package Execute)。
  • 'args': 传递给 'npx' 的参数，'--yes' 自动确认安装包，'@vj-presidio/specif-ai-mcp-server@latest' 指定要运行的 npm 包及其版本。

2. 使用 'bunx' 启动 (如果使用 Bun 运行时):

{
  "specif-ai": {
    "command": "bunx",
    "args": ["@vj-presidio/specif-ai-mcp-server@latest"],
    "disabled": false,
    "autoApprove": []
  }
}

或者指定版本:

{
  "specif-ai": {
    "command": "bunx",
    "args": ["@vj-presidio/[email protected]"],
    "disabled": false,
    "autoApprove": []
  }
}
  • 'command': 指定启动服务器的命令为 'bunx' (Bun Package Execute)。
  • 'args': 传递给 'bunx' 的参数，'@vj-presidio/specif-ai-mcp-server@latest' 指定要运行的 bun 包及其版本。

3. 使用全局安装的二进制文件或包启动:

{
  "specif-ai": {
    "command": "specif-ai-mcp-server",
    "args": [],
    "disabled": false,
    "autoApprove": []
  }
}
  • 'command': 指定启动服务器的命令为 'specif-ai-mcp-server' (假设已全局安装并添加到 PATH 环境变量)。
  • 'args': 参数为空，因为服务器已全局安装，可以直接通过命令名启动。

基本使用方法

  1. 启动服务器: 根据您的安装方式，MCP 客户端会在需要时自动启动 Specif-ai MCP Server。

  2. 设置项目路径 (首次使用或更换项目):

    您可以使用 'set-project-path' 工具来设置项目路径。项目路径应指向包含规范文档（BRD, PRD, NFR, UIR, BP 文件夹及其 JSON 文件）的根目录。

    例如，通过 MCP 客户端调用以下工具:

    {
  "name": "set-project-path",
  "arguments": {
    "path": "./path/to/your/project"  // 将 "./path/to/your/project" 替换为您的项目路径
  }
}

  3. 查询文档信息:

    您可以使用以下工具来获取不同类型的文档信息。以下是一些示例工具调用，您可以通过 MCP 客户端发送这些 JSON 请求来与服务器交互。

    • 获取所有 BRD 文档:

      {
  "name": "get-brds",
  "arguments": {
    "cwd": "./" // 当前工作目录，用于自动推断项目路径
  }
}

    • 获取所有 PRD 文档:

      {
  "name": "get-prds",
  "arguments": {
    "cwd": "./"
  }
}

    • 获取特定 PRD 的用户故事 (假设 PRD ID 为 "PRD01"):

      {
  "name": "get-user-stories",
  "arguments": {
    "prdId": "PRD01",
    "cwd": "./"
  }
}

    • 获取特定用户故事的任务 (假设 PRD ID 为 "PRD01", 用户故事 ID 为 "US1"):

      {
  "name": "get-tasks",
  "arguments": {
    "prdId": "PRD01",
    "userStoryId": "US1",
    "cwd": "./"
  }
}

    • 获取特定任务的详细信息 (假设 PRD ID 为 "PRD01", 用户故事 ID 为 "US1", 任务 ID 为 "T1"):

      {
  "name": "get-task",
  "arguments": {
    "prdId": "PRD01",
    "userStoryId": "US1",
    "taskId": "T1",
    "cwd": "./"
  }
}

    • 获取其他文档类型 (NFR, UIR, BP) 的方法类似，只需将工具名称替换为 'get-nfrs', 'get-uirs', 'get-bps' 即可。

  4. 查看帮助信息:

    在命令行中运行 'specif-ai-mcp-server --help' 或 'specif-ai-mcp-server -h' 可以查看服务器的帮助信息和可用选项。

注意事项

  • 确保您的项目目录下包含 BRD, PRD, NFR, UIR, BP 等文件夹，并且每个文件夹下都包含符合规范的 JSON 文档。
  • 'cwd' 参数用于服务器自动推断项目路径。通常情况下，您可以将 'cwd' 设置为当前工作目录 './'。
  • 使用 'set-project-path' 工具设置项目路径后，服务器会重新加载文档数据。

通过以上步骤，您可以成功安装、配置和使用 Specif-ai MCP Server，为您的 LLM 应用提供结构化规范文档的上下文信息服务。

信息

分类

开发者工具

访问项目