Xai MCP

🚀 Xircuits MCP组件库

本组件库专为Xircuits打造，用于实现模型上下文协议（MCP）服务器。借助它，你能通过Xircuits视觉编程界面，轻松创建、配置和运行MCP服务器。

🚀 快速开始

如果你想使用此组件库，需要先了解模型上下文协议（MCP）。模型上下文协议（MCP）可构建API，以安全、标准化的方式将数据和功能暴露给大型语言模型（LLM）应用，可看作是专门为LLM交互设计的Web API。MCP服务器具备多种功能，例如通过资源（类似GET端点，用于加载信息到LLM上下文中）、工具（类似POST端点，用于执行代码或产生副作用）、提示（定义LLM交互模式的重用模板）等。

✨ 主要特性

• 提供易于使用的组件，可通过Xircuits视觉编程界面创建、配置和运行MCP服务器。
• 组件按功能分类，包括服务器设置、起始节点、结果设置等，方便管理和使用。

📦 安装指南

先决条件

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

安装步骤

要使用此组件库，请确保安装了Xircuits，然后运行以下命令：

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

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

pip install -r requirements.txt

💻 使用示例

本组件库提供了丰富的组件，以下为你详细介绍各组件及其功能：

服务器设置组件

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

起始节点组件

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

• MCPDefineTool(Royal Blue)：为MCP服务器定义一个工具，允许LLM执行操作和计算。
• MCPDefineResource(Lime Green)：为MCP服务器定义一个资源，允许LLM通过URI模式访问数据。
• MCPDefinePrompt(Dark Orchid)：为MCP服务器定义一个提示模板，提供供LLM重用的交互模式。
• MCPServerOnStart(Dark Orange)：定义当MCP服务器启动时执行的代码。
• MCPServerOnShutdown(Firebrick)：定义当MCP服务器关闭时执行的代码。

结果设置组件

这些组件用于在起始节点正文内部设置工具、资源或提示执行的结果：

• MCPSetToolResult (Royal Blue)：设置工具执行的结果。
• MCPSetResourceResult(Lime Green)：设置资源执行的结果。
• MCPSetPromptResult(Dark Orchid)：设置提示执行的结果。

📚 详细文档

• 模型上下文协议文档
• 模型上下文协议规范
• 官方支持的服务器

📄 许可证

本项目采用Apache License 2.0许可协议。