Openai Agents SDK MCP Server

OpenAI代理SDK MCP服务器

综合##📚 文档

📖 设置和使用指南 -完整的安装、配置和使用说明

本指南涵盖了您需要的一切：

• 快速安装和设置
• 所有AI助手的配置（Cursor、Cline、Claude Desktop）
• 可用工具和使用示例
• 常见问题排查

📋 PrequisitesCP（模型上下文协议）服务器，提供对完整 OpenAI代理Python SDK Cursor、Cline和Roo等AI编码助手的文档。

🎯 概述

此MCP服务器使AI编码助手能够访问最新的OpenAI代理SDK文档，包括：

• 15+文档部分：从快速入门到高级主题的全面覆盖
• API参考资料：Agent、Runner、工具和模型的详细文档
• 智能搜索：智能搜索，对所有文档进行相关性评分
• 代码示例：提取和交付相关代码示例
• 智能高速缓存：30分钟缓存，在保持最新状态的同时最大限度地减少API调用

🚀 特性

📚 完整的文档覆盖范围

• 入门指南：概述，快速入门指南
• 核心概念：代理、运行代理、工具、交接、护栏
• 配置：型号、SDK配置
• 高级：上下文管理
• 调试与监控：跟踪、代理可视化
• 整合：模型上下文协议（MCP）
• 例子：现实世界的实施模式
• api参考：所有类的完整API文档

🔍 智能搜索功能

• 关键字搜索：查找相关文档部分
• 类别筛选：按文档类别筛选
• 相关性评分：按相关性排列的结果
• 多词搜索：有效处理复杂的查询

💻 代码示例提取

• 目标示例：获取特定主题的示例
• 代码块提取：自动提取Python代码块
• 主题映射：智能地将主题映射到相关章节

⚡ 性能优化

• 智能高速缓存：30分钟TTL，平衡新鲜度和性能
• 高效抓取：仅在请求时获取内容
• 错误处理：当内容不可用时，性能会下降

文件

• 使用指南 -详细的使用示例和集成说明
• 配置指南 -所有AI助手的完整设置说明
• 实施审查 -技术深度挖掘和架构概述

�📋 先决条件

• Node.js 18+
• npm 或 纱线

🛠 安装和快速启动

选项1：从npm安装（推荐）

# Install globally for easy access
npm install -g openai-agents-sdk-mcp-server

# Get your configuration
npx openai-agents-mcp-config

选项2：克隆和构建

# Clone the repository
git clone https://github.com/kenneth-tao/openai-agents-sdk-mcp-server.git
cd openai-agents-sdk-mcp-server

# Install dependencies and build
npm install
npm run build

# Get your configuration
node get-config.js

测试安装

# Test the server (for global install)
openai-agents-mcp

# Or for local install
npm start

服务器将启动并显示： OpenAI Agents Python MCP Server running on stdio

✅ 已修复的问题

以下TypeScript问题已得到解决：

• ✅ 类型安全：添加了适当的接口 DocumentationSection 和 DocumentationSections
• ✅ 对象索引：使用适当的类型保护修复了不安全的对象属性访问
• ✅ 参数验证：为工具参数添加了正确的类型检查
• ✅ 错误处理：通过适当的类型保护改进了错误处理
• ✅ 资源注释：修复了资源注释中缺少的URL属性
• ✅ 地图类型问题：使用适当的基于数组的Map结构固定类别分组

🔧 MCP服务器配置

可用资源

服务器提供对15+文档资源的访问：

可用工具

🔍 search_documentation

搜索所有OpenAI代理SDK文档。

参数：

• query （字符串，必填）：搜索查询
• category （字符串，可选）：按类别筛选

类别：

• Getting Started, Core Concepts, Configuration, Advanced
• Debugging & Monitoring, Integration, Examples, API Reference

例子：

{
  "name": "search_documentation",
  "arguments": {
    "query": "function tools with validation",
    "category": "Core Concepts"
  }
}

📝 get_code_examples

获取特定SDK功能的代码示例。

参数：

• topic （string，必填）：获取示例的主题

支持的主题：

• basic agent, function tools, handoffs, guardrails
• tracing, models, context, mcp

例子：

{
  "name": "get_code_examples",
  "arguments": {
    "topic": "function tools"
  }
}

🔌 与AI助手集成

快速配置

安装后，获取配置：

# Get configuration for your system
npx openai-agents-mcp-config

这将输出正确的 command 和 args 根据您的安装类型。

光标配置

添加到光标设置(settings.json):

{
  "mcp.servers": {
    "openai-agents-sdk": {
      "command": "openai-agents-mcp",
      "args": [],
      "description": "OpenAI Agents SDK documentation",
      "disabled": false
    }
  }
}

临床配置

添加到您的Cline MCP设置中：

{
  "mcpServers": {
    "openai-agents-sdk": {
      "command": "openai-agents-mcp",
      "args": [],
      "env": {},
      "disabled": false
    }
  }
}

Roo配置

配置Roo以使用相同的命令和参数使用此MCP服务器。

📖 有关所有AI助手的详细配置说明，请参阅 docs/CONFIGURATION.md

🎯 使用示例

一旦配置了您的AI助手，您就可以提出以下问题：

基本用法

• *“如何使用OpenAI代理SDK创建基本代理？”*
• *“演示如何向代理添加功能工具”*
• *“运行代理的语法是什么？”*

高级功能

• *“我如何实现代理人之间的交接？”*
• *“演示如何设置输入验证的护栏”*
• *“如何启用代理工作流的跟踪？”*

API参考资料

• *“Agent类构造函数的参数是什么？”*
• *“如何配置Runner类？”*
• *“Tool类上有哪些可用方法？”*

📖 有关更详细的示例和集成指南，请参阅 docs/USAGE.md

📁 项目结构

├── src/
│   └── index.ts              # Main MCP server implementation
├── dist/                     # Compiled JavaScript files
├── docs/                     # Documentation
│   ├── USAGE.md             # Detailed usage guide
│   ├── CONFIGURATION.md     # Setup and configuration
│   └── IMPLEMENTATION_REVIEW.md # Technical architecture review
├── .vscode/
│   ├── launch.json          # Debug configuration
│   ├── tasks.json           # Build tasks
│   └── mcp.json             # MCP server configuration
├── .github/
│   └── copilot-instructions.md  # Copilot instructions
├── package.json             # Project configuration
├── tsconfig.json            # TypeScript configuration
├── README.md                # This file
└── test.js                  # Test script

🔧 发展

构建命令

# Build the project
npm run build

# Start the server
npm start

# Development mode (auto-rebuild)
npm run dev

# Run tests
npm test

在VS代码中调试

1. 在VS Code中打开项目
2. 按 F5 或转到运行和调试
3. 选择“调试MCP服务器”
4. 服务器将自动构建并在调试模式下启动

🤝 贡献

此MCP服务器的设计是稳健和全面的。如果您发现任何问题或有改进建议，请随时贡献。

📄 许可证

MIT许可证

______________________________________________________________________

准备好用OpenAI代理SDK知识为您的AI编码助手充电！ 🚀