Xircuits MCP Component Library

基本能力

产品定位

xai-mcp 是一个用于构建 MCP 服务器的组件库，旨在通过可视化编程界面简化 MCP 服务器的开发过程。

核心功能

1. 创建和运行 MCP 服务器：提供组件用于创建和启动 MCP 服务器。
2. 定义工具（Tools）：允许 LLM 执行操作和计算。
3. 定义资源（Resources）：允许 LLM 通过 URI 模式访问数据。
4. 定义提示模板（Prompts）：提供可重用的 LLM 交互模式。
5. 服务器生命周期管理：支持定义服务器启动和关闭时的行为。

适用场景

1. LLM 应用开发：为 LLM 应用提供标准化的数据暴露和功能调用接口。
2. 可视化编程：通过 Xircuits 界面快速构建 MCP 服务器。
3. 模型集成：将现有模型或功能集成到 MCP 服务器中，供 LLM 调用。

工具列表

1. MCPCreateServer：创建 MCP 服务器实例。
2. MCPRunServer：启动并运行 MCP 服务器。
3. MCPDefineTool：定义工具，供 LLM 执行操作。
4. MCPDefineResource：定义资源，供 LLM 访问数据。
5. MCPDefinePrompt：定义提示模板，供 LLM 交互使用。
6. MCPServerOnStart/MCPServerOnShutdown：定义服务器启动和关闭时的行为。
7. MCPSetToolResult/MCPSetResourceResult/MCPSetPromptResult：设置工具、资源或提示的执行结果。
8. 其他实用组件：如创建图像、获取参数、报告进度等。

常见问题解答

1. 如何安装？ 确保已安装 Python 3.8+、Xircuits 和 MCP Python SDK，然后运行 xircuits install https://github.com/xpressai/xai-mcp。
2. 如何手动安装？ 克隆仓库后运行 pip install -r requirements.txt。
3. 如何定义工具？ 使用 MCPDefineTool 组件，并通过 MCPSetToolResult 设置结果。
4. 如何管理服务器生命周期？ 使用 MCPServerOnStart 和 MCPServerOnShutdown 组件。

使用教程

使用依赖

1. Python 3.8 或更高版本
2. Xircuits
3. MCP Python SDK

安装教程

1. 确保已安装 Xircuits。
2. 运行以下命令安装组件库： xircuits install https://github.com/xpressai/xai-mcp
3. 或手动克隆仓库后运行： pip install -r requirements.txt

调试方式

1. 创建 Xircuits 工作流。
2. 添加 MCPCreateServer 组件创建服务器实例。
3. 使用 MCPDefineTool、MCPDefineResource 和 MCPDefinePrompt 定义服务器功能。
4. 通过 MCPSetToolResult、MCPSetResourceResult 或 MCPSetPromptResult 设置结果。
5. 可选：使用 MCPServerOnStart 和 MCPServerOnShutdown 管理生命周期。
6. 添加 MCPRunServer 启动服务器。

示例：创建计算器工具

1. 将 MCPDefineTool 拖到画布上。
2. 设置名称为 "add"，描述为 "Add two numbers"。
3. 连接 MCPGetArgument 获取参数 "a" 和 "b"。
4. 连接组件执行加法操作。
5. 使用 MCPSetToolResult 设置结果。

许可证

该项目遵循 Apache-2.0 开源许可条款，请参阅 Apache-2.0 了解完整条款。