内容
# mcp-grok-websearch
一款MCP服务器,暴露了[Grok Build CLI](https://x.ai/cli)的内置`web_search`功能,作为标准的MCP工具。任何与MCP兼容的代理(Codex、Claude Desktop、Cursor等)都可以使用它进行实时网络搜索。
## 前置条件
1. **Grok Build CLI** 已安装并认证:
```bash
curl -fsSL https://x.ai/cli/install.sh | bash
grok login # OAuth,或在下面设置GROK_CODE_XAI_API_KEY
```
2. **uv** (用于`uvx`):https://docs.astral.sh/uv/
## 用法
### 直接使用uvx运行(无需安装)
```bash
uvx mcp-grok-websearch
```
### 在MCP兼容的代理中配置
将以下内容添加到代理的MCP配置中(例如 `~/.codex/config.json`、`claude_desktop_config.json` 等):
```json
{
"mcpServers": {
"websearch": {
"command": "uvx",
"args": ["mcp-grok-websearch"]
}
}
}
```
如果您使用API密钥而不是 `grok login`:
```json
{
"mcpServers": {
"websearch": {
"command": "uvx",
"args": ["mcp-grok-websearch"],
"env": {
"GROK_CODE_XAI_API_KEY": "xai-..."
}
}
}
}
```
## MCP 工具
### `web_search`
使用Grok的内置搜索功能实时搜索网络。
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| `query` | `str` | 必需 | 搜索查询 |
| `max_results` | `int` | `5` | 结果数量(1–20) |
**返回:** 格式化的结果,每个结果包含 `Title`、`URL` 和 `Summary`,由 `---` 分隔。
**示例结果:**
```
Title: 模型上下文协议 – Anthropic
URL: https://modelcontextprotocol.io
Summary: MCP的官方网站,MCP是连接AI到外部工具和数据源的开放标准。
---
Title: MCP GitHub 仓库
URL: https://github.com/modelcontextprotocol
Summary: 模型上下文协议的源代码和SDK。
---
```
## 认证
服务器支持两种模式,按以下顺序尝试:
1. **API密钥** – 在环境中设置 `GROK_CODE_XAI_API_KEY` (或 `XAI_API_KEY`)。
2. **OAuth会话** – 如果没有密钥,则使用机器上现有的 `grok login` 会话。
## 许可证
MIT