Xai MCP

🚀 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許可協議。