🚀 Xircuits MCP组件库

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

🚀 快速开始

Xircuits MCP组件库为开发者提供了便捷的方式来实现MCP服务器。通过Xircuits的视觉编程界面，无需复杂的代码编写，就能快速搭建起功能完备的MCP服务器。

✨ 主要特性

• 可视化操作：利用Xircuits视觉编程界面，降低开发门槛，提高开发效率。
• 功能丰富：提供多种组件，涵盖服务器设置、起始节点定义、结果设置等，满足不同场景需求。
• 标准化协议：基于模型上下文协议（MCP），以安全、标准化的方式将数据和功能暴露给大型语言模型（LLM）应用。

📦 安装指南

先决条件

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

安装步骤

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

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

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

pip install -r requirements.txt

💻 使用示例

基础用法

以下为使用组件创建和运行MCP服务器的基础示例：

# 假设以下是使用组件创建和运行MCP服务器的代码示例
# 创建一个FastMCP服务器实例
# 这里使用MCPCreateServer组件
# 然后使用MCPRunServer组件启动服务器

高级用法

在实际应用中，你可能需要定义工具、资源和提示等功能。以下是一个高级用法示例：

# 定义一个工具
# 使用MCPDefineTool组件
# 定义一个资源
# 使用MCPDefineResource组件
# 定义一个提示模板
# 使用MCPDefinePrompt组件

📚 详细文档

组件说明

此库提供了用于实现MCP服务器的组件，按以下几类组织：

服务器设置组件

• 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许可协议。