ConechoAI_openai-websearch-mcp 仓库详细介绍
概述
欢迎来到 ConechoAI_openai-websearch-mcp 仓库的详细文档。本仓库由 MCP-Mirror 创建,链接为 GitHub仓库地址。该仓库为 原始项目 的镜像版本,旨在通过模型上下文协议(Model Context Protocol,简称MCP)提供OpenAI的网络搜索功能。这一服务可使AI助手在与用户对话时,实时搜索并获取最新信息,补充其训练数据中可能缺失的部分。
功能介绍
核心功能
OpenAI WebSearch MCP是一个MCP服务器,它的主要功能是通过OpenAI的Web搜索引擎在对话中实时获取信息。这一功能特别适用于以下场景:
- 提供最新的事实信息,例如新闻动态、市场数据等。
- 增强客户支持功能,通过实时获取知识库中的最新内容。
- 在教育领域,充实教学和学习资源,提供即时的资源链接和知识点拓展。
安装与配置
该服务器支持一键安装和配置,亦可手动进行设置。以下将详细介绍安装及配置步骤。
一键安装及配置
适用于Claude应用
可以通过以下命令进行自动更新和配置(推荐):
OPENAI_API_KEY=sk-xxxx uv run --with uv --with openai-websearch-mcp openai-websearch-mcp-install
在上述命令中,
sk-xxxx
为您的API密钥,您可以从 OpenAI开放平台 获取。手动安装和配置
请确保在安装前已安装
uvx
。以下是手动配置的方法:- 通过uvx进行配置
在Claude设置中添加如下配置:
"mcpServers": {
"openai-websearch-mcp": {
"command": "uvx",
"args": ["openai-websearch-mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
}
- 通过pip进行安装
1)首先,通过pip安装
openai-websearch-mcp
:pip install openai-websearch-mcp
2)然后,修改Claude设置如下:
"mcpServers": {
"openai-websearch-mcp": {
"command": "python",
"args": ["-m", "openai_websearch_mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
}
配置Zed编辑器
为了在Zed编辑器中使用openai-websearch-mcp,可以在settings.json中进行配置:
使用uvx
"context_servers": [
"openai-websearch-mcp": {
"command": "uvx",
"args": ["openai-websearch-mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
],
使用pip安装
"context_servers": {
"openai-websearch-mcp": {
"command": "python",
"args": ["-m", "openai_websearch_mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
},
可用工具
在OpenAI WebSearch MCP中,用户可以使用以下工具:
web_search
:调用OpenAI网络搜索工具。- 必需参数:
type
(字符串):web_search_preview
search_context_size
(字符串): 指导搜索使用的上下文窗口大小,可以选择低、中、高,默认值为中。user_location
(对象或空):type
(字符串): 地点类型,通常是一个大致位置。city
(字符串): 城市名称,例如“San Francisco”。country
(字符串): 使用ISO两字码表示国家,例如“US”。region
(字符串): 地区名称,例如“California”。timezone
(字符串): IANA时区,例如“America/Los_Angeles”。
- 必需参数:
调试技巧
用户可以使用MCP Inspector调试服务器,尤其是通过uvx安装的环境下:
npx @modelcontextprotocol/inspector uvx openai-websearch-mcp
结论
通过详细配置OpenAI WebSearch MCP,用户将能够享受到实时、动态的信息获取功能。这不仅能够帮助增强对话体验,还能为各类应用场景提供强有力的支持和实力提升。无论是在提升AI助手功能还是在用户参与度方面,OpenAI的Web搜索能力都能大显身手。
如需进一步探索本项目,请访问 GitHub仓库。