使用说明

项目简介

Holaspirit MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它充当 AI 助手和 Holaspirit 组织管理平台之间的桥梁。通过提供 MCP 协议接口,该服务器允许 AI 助手以标准化的方式访问 Holaspirit 中的数据和功能,例如任务、圈子、角色、会议等。

主要功能点

  • 工具化访问 Holaspirit API: 将 Holaspirit API 的各项功能封装成 MCP 工具,例如列出任务、圈子、角色等,方便 AI 助手调用。
  • 资源数据访问: 提供对 Holaspirit 组织内各种资源(如任务、指标、圈子、角色、领域、策略、会议)的读取能力。
  • 标准化 MCP 接口: 遵循 MCP 协议标准,使用 JSON-RPC 进行通信,易于与各种 MCP 客户端集成。
  • Stdio 传输协议: 使用 Stdio 作为默认的传输协议,简化部署和运行。

安装步骤

  1. 安装 npm 包: 在你的项目目录下,运行以下命令安装 'holaspirit-mcp-server':
    npm install holaspirit-mcp-server
  2. 配置 Holaspirit API 令牌: 在项目根目录下创建 '.env' 文件,并添加你的 Holaspirit API 令牌:
    HOLASPIRIT_API_TOKEN=your_api_token
    请确保替换 'your_api_token' 为你实际的 Holaspirit API 令牌。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Holaspirit MCP Server。这是一个 JSON 格式的配置示例,你需要将其提供给你的 MCP 客户端:

{
  "serverName": "holaspirit-mcp-server",
  "command": "npx",
  "args": [
    "holaspirit-mcp-server"
  ]
}
  • 'serverName': MCP 服务器的名称,可以自定义。
  • 'command': 启动 MCP 服务器的命令。这里 'npx' 用于执行本地安装的 'holaspirit-mcp-server' 包。
  • 'args': 传递给启动命令的参数,本例中没有额外的参数。

注意: 请确保你的环境中已安装 Node.js 和 npm,并且 'npx' 命令可用。

基本使用方法

  1. 启动 MCP 服务器: 在安装了 'holaspirit-mcp-server' 的项目目录下,运行以下命令启动服务器:

    npx holaspirit-mcp-server

    服务器成功启动后,会在控制台输出 "Holaspirit MCP Server running on stdio"。

  2. 配置和运行 MCP 客户端: 使用兼容 MCP 协议的客户端,并按照 服务器配置 中的信息配置客户端,使其连接到正在运行的 Holaspirit MCP Server。你可以参考仓库中的 'examples' 目录下的示例代码,了解如何使用 MCP 客户端与服务器进行交互,例如列出圈子信息。

  3. 调用工具: 通过 MCP 客户端,你可以发送请求调用服务器提供的工具,例如 'list_circles'、'list_tasks' 等,以获取 Holaspirit 组织中的数据。工具的具体参数和使用方法请参考服务器提供的工具列表(通过客户端的 'listTools' 请求获取)以及仓库 'README.md' 中的工具描述。

信息

分类

商业系统