Xircuits MCP Component Library

Xircuits MCP 组件库

用于实现 Model Context Protocol（MCP）服务的 Xircuits 组件库。该库提供的组件可帮助你使用 Xircuits 可视化编程界面轻松创建、配置和运行 MCP 服务。

什么是 Model Context Protocol（MCP）？

Model Context Protocol（MCP） 让你能够构建以安全、标准化的方式向大模型应用公开数据和功能的服务。你可以把它看作 Web API，但它专为大模型交互而设计。MCP 服务可以：

• 通过 资源 公开数据（可以把它们看作 GET 端点；用于将信息加载到大模型的上下文中）
• 通过 工具 提供功能（类似 POST 端点；用于执行代码或以其他方式产生副作用）
• 通过 提示词 定义交互模式（用于大模型交互的可复用模板）
• 还有更多功能！

前置条件

• Python 3.8 或更高版本
• Xircuits
• MCP Python SDK

安装

要使用此组件库，请确保已安装 Xircuits，然后运行：

xircuits install https://github.com/xpressai/xai-mcp

或者，你也可以手动将目录复制到工作中的 Xircuits 项目目录，或将仓库克隆为子模块，然后使用以下命令安装软件包：

pip install -r requirements.txt

组件

该库提供用于实现 MCP 服务的组件，分为以下几个类别：

服务设置组件

• MCPCreateServer：创建具有指定名称和可选依赖项的 FastMCP 服务实例。
• MCPRunServer：启动 MCP 服务并使其持续运行，直到被中断。

起始节点组件

这些组件作为定义 MCP 服务功能的入口点。可以将它们拖到画布上，用于实现对事件的响应：

• MCPDefineTool（皇家蓝）：为 MCP 服务定义一个工具，让大模型能够执行操作和计算。
• MCPDefineResource（石灰绿）：为 MCP 服务定义一个资源，让大模型能够通过 URI 模式访问数据。
• MCPDefinePrompt（深兰花紫）：为 MCP 服务定义提示词模板，为大模型提供可复用的交互模式。
• MCPServerOnStart（深橙色）：定义 MCP 服务启动时要执行的代码。
• MCPServerOnShutdown（砖红色）：定义 MCP 服务关闭时要执行的代码。

结果设置组件

这些组件用于起始节点的主体部分，以设置工具、资源或提示词执行的结果：

• MCPSetToolResult（皇家蓝）：设置工具执行的结果。
• MCPSetResourceResult（石灰绿）：设置资源执行的结果。
• MCPSetPromptResult（深兰花紫）：设置提示词执行的结果。

实用组件

• MCPCreateImage：创建供 MCP 工具和资源使用的 Image 对象。
• MCPGetArgument：从 args 字典中获取参数。
• MCPReportProgress：报告长时间运行操作的进度。
• MCPReadResource：从 MCP 服务读取资源。
• MCPCreateUserMessage：创建供提示词使用的用户消息。
• MCPCreateAssistantMessage：创建供提示词使用的助手消息。
• MCPCreateMessageList：创建供提示词使用的消息列表。

使用示例

以下示例介绍如何使用此组件库创建 MCP 服务：

1. 创建一个新的 Xircuits 工作流
2. 添加 MCPCreateServer 组件以创建服务实例
3. 添加 MCPDefineTool、MCPDefineResource 和 MCPDefinePrompt 起始节点，以定义服务的功能
4. 对于每个起始节点，连接组件以实现工具、资源或提示词的逻辑
5. 使用 MCPSetToolResult、MCPSetResourceResult 或 MCPSetPromptResult 设置结果
6. 可以选择添加 MCPServerOnStart 和 MCPServerOnShutdown 起始节点，以定义服务的生命周期行为
7. 添加 MCPRunServer 组件以启动服务

示例：创建计算器工具

1. 将 MCPDefineTool 起始节点拖到画布上
2. 将其名称设为 "add"，描述设为 "Add two numbers"
3. 连接一个 MCPGetArgument 组件以获取 "a" 参数
4. 再连接一个 MCPGetArgument 组件以获取 "b" 参数
5. 连接一个用于将这两个数字相加的组件
6. 连接一个 MCPSetToolResult 组件以设置结果

示例：服务生命周期管理

1. 将 MCPServerOnStart 起始节点拖到画布上
2. 连接组件以初始化资源、加载数据或执行其他启动任务
3. 将 MCPServerOnShutdown 起始节点拖到画布上
4. 连接组件以清理资源、保存数据或执行其他关闭任务

文档

• Model Context Protocol 文档
• Model Context Protocol 规范
• 官方支持的服务

许可证

Apache License 2.0