通用工具调用协议 (UTCP)

简介

通用工具调用协议 (Universal Tool Calling Protocol, UTCP) 是一项安全、可扩展的标准，旨在定义并实现跨多种通信协议的工具交互。UTCP 1.0.0 引入了基于插件架构的模块化核心，使其更具扩展性、易于测试且更易于打包。

与其他协议相比，UTCP 特别强调以下几点：

• 可扩展性 (Scalability)：UTCP 旨在处理大量工具和提供程序，同时不牺牲性能。
• 可扩展性 (Extensibility)：插件化架构允许开发者轻松添加新的通信协议、工具存储机制和搜索策略，而无需修改核心库。
• 互操作性 (Interoperability)：随着协议插件生态系统（包括 HTTP、SSE、CLI 等）的不断增长，UTCP 可以与几乎任何现有的服务或基础设施集成。
• 易用性 (Ease of Use)：该协议基于简单且定义明确的 Pydantic 模型构建，方便开发者实现和使用。

仓库结构

本仓库包含了完整的 UTCP Python 实现：

• core/ - 包含基础组件的核心 utcp 包 (README)
• plugins/communication_protocols/ - 协议专用插件：
  • http/ - HTTP/REST、SSE、流式传输、OpenAPI (README)
  • cli/ - 命令行工具 (README)
  • mcp/ - 模型上下文协议 (Model Context Protocol) (README)
  • text/ - 基于文件的工具 (README)
  • socket/ - TCP/UDP (🚧 开发中)
  • gql/ - GraphQL (🚧 开发中)

架构概览

UTCP 采用模块化架构，由核心库和协议插件组成：

核心包 (utcp)

core/ 目录包含了基础组件：

• 数据模型: 用于 Tool、CallTemplate、UtcpManual 和 Auth 的 Pydantic 模型
• 客户端接口: 用于工具交互的主 UtcpClient
• 插件系统: 针对协议、存储库和搜索的可扩展接口
• 默认实现: 内置的工具存储和搜索策略

快速入门

安装

安装核心库以及所需的任何协议插件：

# 安装核心库 + HTTP 插件（最常用）
pip install utcp utcp-http

# 根据需要安装额外插件
pip install utcp-cli utcp-mcp utcp-text

基本用法

from utcp.utcp_client import UtcpClient

# 创建带有 HTTP API 的客户端
client = await UtcpClient.create(config={
    "manual_call_templates": [{
        "name": "my_api",
        "call_template_type": "http",
        "url": "https://api.example.com/utcp"
    }]
})

# 调用工具
result = await client.call_tool("my_api.get_data", {"id": "123"})

协议插件

UTCP 通过专用插件支持多种通信协议：

插件	描述	状态	文档
utcp-http	HTTP/REST APIs, SSE, 流式传输	✅ 稳定	HTTP Plugin README
utcp-cli	命令行工具	✅ 稳定	CLI Plugin README
utcp-mcp	模型上下文协议	✅ 稳定	MCP Plugin README
utcp-text	本地文件工具	✅ 稳定	Text Plugin README
utcp-websocket	WebSocket 实时双向通信	✅ 稳定	WebSocket Plugin README
utcp-socket	TCP/UDP 协议	🚧 开发中	Socket Plugin README