using openai websearch as mcp server
Project description
OpenAI WebSearch MCP Server
This MCP server provides access to OpenAI's websearch functionality through the Model Context Protocol. It allows AI assistants to search the web during conversations with users, providing up-to-date information that may not be available in the assistant's training data. The server can be installed and configured for use with Claude.app or Zed editor.
One click installation & Configuration
Claude
!!Can using this command auto update configure file(Recommend)
OPENAI_API_KEY=sk-xxxx uv run --with uv --with openai-websearch-mcp openai-websearch-mcp-install
sk-xxxx is your API key. You can get it from openai's open platform
Cursor
Conming soon
Windsurf
Conming soon
Available Tools
web_search- Call openai websearch as tool.- Required arguments:
type(string): web_search_previewsearch_context_size(string): High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.user_location(object or null)type(string): The type of location > approximation. Always approximate.city(string): Free text input for the city of the user, e.g. San Francisco.country(string): The two-letter ISO country code of the user, e.g. US.region(string): Free text input for the region of the user, e.g. California.timezone(string): The IANA timezone of the user, e.g. America/Los_Angeles.
- Required arguments:
Manual installation and configuration
Please make sure uvx is installed before installation
Add to your Claude settings:
1、Using uvx
"mcpServers": {
"openai-websearch-mcp": {
"command": "uvx",
"args": ["openai-websearch-mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
}
2、Using pip installation
1)install openai-websearch-mcp via pip:
pip install openai-websearch-mcp
2)modify your Claude settings
"mcpServers": {
"openai-websearch-mcp": {
"command": "python",
"args": ["-m", "openai_websearch_mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
}
Configure for Zed
Add to your Zed settings.json:
Using uvx
"context_servers": [
"openai-websearch-mcp": {
"command": "uvx",
"args": ["openai-websearch-mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
],
Using pip installation
"context_servers": {
"openai-websearch-mcp": {
"command": "python",
"args": ["-m", "openai_websearch_mcp"],
"env": {
"OPENAI_API_KEY": "your-api-key-here"
}
}
},
Debugging
You can use the MCP inspector to debug the server. For uvx installations:
npx @modelcontextprotocol/inspector uvx openai-websearch-mcp
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mseep_openai_websearch_mcp-0.4.0.tar.gz.
File metadata
- Download URL: mseep_openai_websearch_mcp-0.4.0.tar.gz
- Upload date:
- Size: 23.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b9bbc15668233cd124a8e24648fc71c27f273aae0c970d47716a104952ecb2cb
|
|
| MD5 |
593831908217ead03ad95dcc44efdb57
|
|
| BLAKE2b-256 |
fa2249aba1a16dbb2107f5f3b45771281af575c23d48715fdc677ce7921ea037
|
File details
Details for the file mseep_openai_websearch_mcp-0.4.0-py3-none-any.whl.
File metadata
- Download URL: mseep_openai_websearch_mcp-0.4.0-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0642be242e2f025a20456a78d1359dd555cf5efde8ec8edd20ca6aa684a7645a
|
|
| MD5 |
dd1995e86a558aa2779c06e5e43f06db
|
|
| BLAKE2b-256 |
0e661f0bc882e08639e4b63229c4bb120224f49cd44ffea232be29bdc533a1b1
|