Flowcore Platform MCP Server 使用说明

项目简介

Flowcore Platform MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用，它作为 Flowcore 平台与 LLM 客户端之间的桥梁，旨在为 AI 助手等应用提供结构化的数据访问和功能调用能力。通过 MCP 协议，LLM 客户端可以安全、便捷地与 Flowcore 平台交互，获取上下文信息，执行特定操作。

主要功能点

资源管理: 提供对 Flowcore 平台租户 (Tenant)、数据核心 (Data Core)、流类型 (Flow Type) 和事件类型 (Event Type) 等资源的访问能力。
数据查询: 支持查询租户、数据核心、流类型、事件类型以及事件数据和时间桶等信息。
数据变更: 允许创建、更新和删除数据核心、流类型和事件类型。
事件摄取: 支持将事件数据摄取到指定的事件类型中。
权限控制: 通过用户名/PAT 或服务账户密钥进行身份验证，保障数据访问安全。
Prompt模板: 内置 Flowcore Platform 相关的 Prompt 模板，方便用户快速构建交互式应用。
标准协议: 基于 MCP 协议和 JSON-RPC 通信，易于集成到各种 LLM 客户端。

安装步骤

安装 Node.js 和 npm (或 bun): 确保你的开发环境已安装 Node.js 和 npm 包管理器，或者 bun 运行时。推荐使用 bun 以获得更快的安装和运行速度。

全局安装 (可选): 你可以选择全局安装 '@flowcore/platform-mcp-server' 包，以便在任何目录下直接运行。

npm install -g @flowcore/platform-mcp-server
# 或者使用 bun
# bun install -g @flowcore/platform-mcp-server

直接使用 npx 运行 (推荐): 你也可以使用 'npx' 命令直接运行，无需全局安装。

npx @flowcore/platform-mcp-server --username <Flowcore用户名> --pat <PAT>

服务器配置 (MCP 客户端配置)

MCP 客户端需要配置以下信息才能连接到 Flowcore Platform MCP Server。以下为 JSON 格式的配置示例，请根据你的实际情况进行调整。

{
  "serverName": "Flowcore Platform MCP Server",
  "command": "platform-mcp-server",
  "args": [
    "--username", "<Flowcore用户名>",
    "--pat", "<PAT>"
  ],
  "options": {
    "cwd": ".",
    "stdio": "pipe"
  },
  "langs": [
    "json"
  ]
}

配置参数说明:

'serverName': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器连接。
'command': 启动 MCP 服务器的命令。如果你全局安装了 'platform-mcp-server'，则直接使用 'platform-mcp-server'。如果你使用 'npx' 运行，则使用 'npx @flowcore/platform-mcp-server'。如果你在项目目录下运行，则可能需要使用 'node dist/cli.js' 或 'bun run dist/cli.js' (取决于你的构建方式)。 请注意，上述示例假设你已全局安装 'platform-mcp-server'，并直接使用命令 'platform-mcp-server' 启动。
'args': 启动命令的参数，用于配置 Flowcore Platform MCP Server 的连接认证信息。
- '--username <Flowcore用户名>': 你的 Flowcore 平台用户名。请替换 '<Flowcore用户名>' 为你的实际用户名。
- '--pat <PAT>': 你的 Flowcore 平台个人访问令牌 (Personal Access Token)。请替换 '<PAT>' 为你的实际 PAT。 请务必妥善保管 PAT，避免泄露。
- 如果你使用服务账户密钥进行认证，则需要替换为以下参数:
```
"args": [
    "--serviceAccountId", "<服务账户ID>",
    "--serviceAccountKey", "<服务账户密钥>"
 ],
```
  - '--serviceAccountId <服务账户ID>': 你的 Flowcore 平台服务账户 ID。请替换 '<服务账户ID>' 为你的实际服务账户 ID。
  - '--serviceAccountKey <服务账户密钥>': 你的 Flowcore 平台服务账户密钥。请替换 '<服务账户密钥>' 为你的实际服务账户密钥。 请务必妥善保管服务账户密钥，避免泄露。
'options.cwd': 工作目录，'.' 表示当前目录。
'options.stdio': 标准输入输出配置，'pipe' 表示使用管道进行通信，这是 MCP over Stdio 的标准配置。
'langs': 支持的语言类型，'json' 表示服务器使用 JSON 格式进行数据交互。

基本使用方法

启动 MCP 服务器: 根据你的安装方式和配置，在终端运行启动命令，例如：

platform-mcp-server --username <Flowcore用户名> --pat <PAT>
# 或者使用 npx
# npx @flowcore/platform-mcp-server --username <Flowcore用户名> --pat <PAT>

服务器成功启动后，将监听标准输入，并输出到标准输出。

配置 MCP 客户端: 在你的 MCP 客户端应用中，根据上述 服务器配置 (MCP 客户端配置) 部分提供的信息，配置连接到 Flowcore Platform MCP Server。
使用 MCP 客户端与 Flowcore Platform 交互: 通过 MCP 客户端，你可以向 Flowcore Platform MCP Server 发送 MCP 请求，例如：
- 读取资源: 使用 'read' 请求和资源 URI (例如 'tenant://<tenantId>') 获取租户信息。
- 调用工具: 使用 'tool_call' 请求和工具名称 (例如 'list_data_cores') 以及参数，执行相应的 Flowcore 平台操作。
- 获取 Prompt: 使用 'get_prompt' 请求和 Prompt 名称 (例如 'flowcore_platform_prompt') 获取预定义的 Prompt 模板。
具体的请求格式和操作方式请参考 MCP 协议文档和你的 MCP 客户端使用说明。 Flowcore Platform MCP Server 提供了丰富的工具和资源，可以帮助你构建强大的基于 Flowcore 平台的 LLM 应用。

注意: 请确保你拥有访问 Flowcore 平台的有效用户名/PAT 或服务账户密钥。首次使用前，请仔细阅读 Flowcore 平台和 MCP 协议的相关文档，以便更好地理解和使用 Flowcore Platform MCP Server。

Flowcore Platform MCP Server