OpenAI Web Search MCP Server
项目简介
OpenAI Web Search MCP Server 是由bitibi开发的一个基于TypeScript的服务器,专门用于处理OpenAI的网络搜索功能,并采用多配置协议(MCP: Multi-Config Protocol)。这个服务器的核心功能是利用OpenAI最新的Responses API,通过
web_search_preview
功能为AI模型提供实时的网络搜索能力。安装指南
您可以通过以下两种方式来安装和运行此包:
使用npx直接运行:
npx openai-websearch-mcp-server
全局安装:
将该包安装到全局环境,以便随时调用:
npm install -g openai-websearch-mcp-server
与MCP客户端的集成使用
此服务器被设计用于与MCP(模型上下文协议)客户端配合使用。以下是将其与不同MCP客户端进行集成的步骤:
在Claude Desktop中的配置
在Claude Desktop中进行设置时,需要在设置文件中添加如下配置:
{
"mcpServers": {
"openai_websearch": {
"command": "npx",
"args": [
"-y",
"openai-websearch-mcp-server"
],
"env": {
"OPENAI_API_KEY": "your_api_key"
}
}
}
}
请将
your_api_key
替换为您实际的OpenAI API密钥。环境配置
为了确保正确运行,请遵循以下步骤配置您的环境:
- 设置OpenAI API密钥为环境变量:
export OPENAI_API_KEY='your-api-key-here'
- 启动服务器:
openai-websearch-mcp
默认情况下,服务器运行在端口3000上。您可以通过设置PORT环境变量来更改这一点:
PORT=8080 openai-websearch-mcp
API功能
服务器提供了一个名为
web_search
的网络搜索工具,可以通过MCP协议使用。该工具接受一个查询字符串作为输入,并使用OpenAI的Responses API中的web_search_preview
功能执行实时的网络搜索,为用户提供最新的互联网信息。开发指南
要设置开发环境,请执行以下步骤:
- 克隆代码仓库:
git clone https://github.com/bitibi/OpenAI-WebSearch-MCP-Server.git
- 安装所需依赖项:
npm install
- 启动开发服务器:
npm run dev
构建项目
如需构建该包,可以运行以下命令:
npm run build
许可证
本项目依据 MIT 许可证发布,这意味着您可以自由使用、修改和分发代码,只需保留许可证声明。
应用场景与价值
通过OpenAI Web Search MCP Server,开发者可以轻松集成最新的AI网络搜索功能到任意MCP客户端,极大提升了应用程序获取实时网络信息的能力。这种技术可以在各种应用场景中提供价值,例如在智能助手中,实时获取最新的数据以提供精准的答案;在市场分析工具中,跟踪最新的行业动态等。这种创新的技术结合了OpenAI强大的自然语言处理能力与实时信息的获取,为开发者和终端用户提供了明确的价值增益和使用体验提升。
希望此详细文档能够帮助您更好地理解与使用OpenAI Web Search MCP Server,充分挖掘其潜力实现最佳应用成效。