README
🚀 开源项目:openai-tool2mcp 中文文档
openai-tool2mcp 是一款开源工具,它能让 OpenAI 的原生工具(像网络搜索、代码解释器等)与 MCP 协议兼容。借助该工具,用户可在 MCP 生态系统中运用 OpenAI 提供的强大功能。
🚀 快速开始
本工具可让你在 MCP 生态系统中使用 OpenAI 的强大功能。以下是快速上手的步骤:
示例 1:基本使用
# 基本脚本示例
from openai_tool2mcp import MCPServer, ServerConfig, OpenAIBuiltInTools
config = ServerConfig(
openai_api_key="你的API密钥",
tools=[OpenAIBuiltInTools.WEB_SEARCH.value]
)
server = MCPServer(config)
server.start(transport="stdio")
示例 2:配置为 MCP 兼容服务器
# 配置 MCP 兼容脚本示例
import os
from dotenv import load_dotenv
from openai_tool2mcp import MCPServer, ServerConfig, OpenAIBuiltInTools
load_dotenv()
config = ServerConfig(
openai_api_key=os.environ.get("OPENAI_API_KEY"),
tools=[
OpenAIBuiltInTools.WEB_SEARCH.value,
OpenAIBuiltInTools.CODE_INTERPRETER.value
]
)
server = MCPServer(config)
server.start(transport="stdio")
✨ 主要特性
- 将 OpenAI 的原生工具(如网络搜索、代码解释器)与 MCP 协议兼容。
- 允许用户在 MCP 生态系统中使用 OpenAI 提供的强大功能。
📦 安装指南
使用 pip 安装
pip install openai-tool2mcp
克隆仓库(用于开发)
git clone https://github.com/alohays/openai-tool2mcp.git
cd openai-tool2mcp
💻 使用示例
基础用法
# 基本脚本示例
from openai_tool2mcp import MCPServer, ServerConfig, OpenAIBuiltInTools
config = ServerConfig(
openai_api_key="你的API密钥",
tools=[OpenAIBuiltInTools.WEB_SEARCH.value]
)
server = MCPServer(config)
server.start(transport="stdio")
高级用法
# 配置 MCP 兼容脚本示例
import os
from dotenv import load_dotenv
from openai_tool2mcp import MCPServer, ServerConfig, OpenAIBuiltInTools
load_dotenv()
config = ServerConfig(
openai_api_key=os.environ.get("OPENAI_API_KEY"),
tools=[
OpenAIBuiltInTools.WEB_SEARCH.value,
OpenAIBuiltInTools.CODE_INTERPRETER.value
]
)
server = MCPServer(config)
server.start(transport="stdio")
📚 详细文档
项目架构
序列图说明
sequenceDiagram
participant Claude as "Claude App"
participant MCP as "MCP 客户端"
participant Server as "openai-tool2mcp 服务器"
participant OpenAI as "OpenAI API"
Claude->>MCP: 用户查询需要工具支持
MCP->>Server: MCP 请求
Server->>OpenAI: 转换为 OpenAI 格式请求
OpenAI->>Server: 工具响应
Server->>MCP: 转换为 MCP 格式响应
MCP->>Claude: 显示结果
与 MCP SDK 集成
安装步骤
pip install openai-tool2mcp
配置文件示例(适用于 Claude for Desktop)
{
"mcpServers": {
"openai-tools": {
"command": "openai-tool2mcp",
"args": [
"start",
"--transport",
"stdio",
"--tools",
"retrieval",
"code_interpreter"
]
}
}
}
🔧 技术细节
该项目旨在将 OpenAI 的原生工具与 MCP 协议兼容,允许用户在 MCP 生态系统中使用 OpenAI 提供的强大功能。通过序列图可以清晰地看到,当用户通过 Claude App 查询需要工具支持时,MCP 客户端会向 openai-tool2mcp 服务器发送请求,服务器将请求转换为 OpenAI 格式并发送给 OpenAI API,获取工具响应后再将其转换为 MCP 格式返回给 MCP 客户端,最终显示给用户。
🤝 贡献指南
参与方式
- Fork 该项目仓库
- Clone 到本地机器
- 创建功能或修复分支
- 提交更改并创建 Pull Request
开发设置
# 克隆仓库
git clone https://github.com/alohays/openai-tool2mcp.git
cd openai-tool2mcp
# 以开发模式安装
make install
# 运行测试
make test
# 执行代码检查
make lint
📄 许可证
本项目采用 MIT 许可证,具体细节请参阅 LICENSE 文件。
🙏 致谢
- OpenAI 团队,感谢他们提供的优秀工具和 API
- MCP 社区,感谢开发开放标准协议
- 所有为改进该项目做出贡献的社区成员
📈 项目状态
该项目处于积极开发阶段。核心功能正常运行,但可能会有频繁更新和改进。如遇问题,请在我们的 问题跟踪器 提交。
openai-tool2mcp 是更广泛 MCPortal 计划的一部分,旨在将 OpenAI 的工具与开源 MCP 生态系统连接起来。
Scan to contact