使用说明

项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器，专门用于项目需求收集和管理。它允许用户通过工具创建、更新、查询需求、干系人和项目，并将数据持久化存储为JSON文件。

主要功能点

• 需求管理: 创建、更新、列出、查看和跟踪需求变更历史。
• 干系人管理: 添加和管理项目干系人信息。
• 项目管理: 创建和管理项目，关联需求和干系人。
• 数据持久化: 所有数据以JSON格式存储在本地文件中。
• 工具调用: 通过预定义的工具接口，客户端可以调用服务器功能。

安装步骤

1. 环境准备: 确保已安装 Node.js 和 npm 或 pnpm 包管理器。
2. 克隆仓库: 将 GitHub 仓库 'https://github.com/CaptainCrouton89/requirements-gathering' 克隆到本地。
3. 安装依赖: 在仓库根目录下，打开终端并运行 'pnpm install' 命令安装项目依赖。

服务器配置

MCP 客户端需要配置以下信息以连接到此 MCP 服务器。配置信息为 JSON 格式：

{
  "serverName": "requirements-gathering",
  "command": "pnpm",
  "args": ["start"]
}

• 'serverName': 服务器名称，设置为 "requirements-gathering"。
• 'command': 启动服务器的命令，这里使用 'pnpm' 包管理器。
• 'args': 传递给 'pnpm' 命令的参数，'start' 脚本用于启动生产模式的服务器。

注意: 如果需要在开发模式下运行，可以将 'args' 修改为 '["dev"]'，并使用 'pnpm dev' 命令启动服务器。

基本使用方法

1. 启动服务器: 在仓库根目录下，运行 'pnpm start' 命令启动服务器。
2. 连接客户端: 使用兼容 MCP 协议的客户端连接到服务器。客户端需要配置上述服务器配置信息。
3. 调用工具: 客户端连接成功后，可以调用服务器提供的工具来管理需求、干系人和项目。 例如，可以使用 'requirements/add' 工具添加新需求，使用 'requirements/list' 工具列出需求等。
4. 查看帮助: 可以尝试调用 'welcome' prompt 获取可用工具列表和基本使用说明。

示例工具调用 (假设使用 MCP 客户端):

添加新需求:

{
  "method": "tool_call",
  "params": {
    "tool_name": "requirements/add",
    "parameters": {
      "title": "用户登录功能",
      "description": "用户应该能够使用用户名和密码登录系统。",
      "priority": "high",
      "category": "功能性需求"
    }
  }
}

列出需求:

{
  "method": "tool_call",
  "params": {
    "tool_name": "requirements/list",
    "parameters": {}
  }
}