article
README
🚀 OpenAI 网络搜索 MCP 服务器
本项目是一个用 TypeScript 实现的 MCP 服务器,为用户提供基于 OpenAI 的网络搜索预览功能。借助 OpenAI 最新的响应 API 和 web_search_preview 功能,AI 模型可通过 OpenAI API 实现实时网络搜索,获取互联网上的最新信息。
🚀 快速开始
本服务器可直接使用 npx 运行,也能全局安装后使用。同时,它设计用于与 MCP(模型上下文协议)客户端配合,如 Claude Desktop。使用前需配置好 OpenAI API 密钥。
✨ 主要特性
- 采用 TypeScript 实现,提供稳定的 MCP 服务器。
- 利用 OpenAI 最新响应 API 和
web_search_preview功能,支持 AI 模型实时网络搜索。 - 可与 MCP 客户端无缝集成,如 Claude Desktop。
📦 安装指南
直接使用 npx 运行
npx openai-websearch-mcp-server
全局安装
npm install -g openai-websearch-mcp-server
💻 使用示例
与 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 的响应 API 和 web_search_preview 功能实现实时网络搜索,从互联网各个来源获取最新信息。
开发
要设置开发环境,请按以下步骤操作:
- 克隆仓库。
- 安装依赖:
npm install
- 启动开发服务器:
npm run dev
构建
要构建包,请运行以下命令:
npm run build
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫