内容
# @openserp/mcp
[](https://www.npmjs.com/package/@openserp/mcp)
[](https://github.com/openserpapi/mcp/blob/main/LICENSE.md)
OpenSERP OSS 和 OpenSERP Cloud 的模型上下文协议(MCP)服务器。 为 MCP 客户端提供搜索、图片搜索、网址提取、使用情况和引擎元数据等工具。
当未设置 `OPENSERP_API_KEY` 时,服务器在 `http://localhost:7000` 处使用 OSS 模式,并写入:
```text
[openserp-mcp] 未设置 OPENSERP_API_KEY - 在 http://localhost:7000 处使用 OSS 模式。
[openserp-mcp] 获取 API 密钥:https://openserp.org/dashboard/keys
[openserp-mcp] 文档:https://openserp.org/docs | 问题:https://github.com/openserpapi/mcp/issues
```
设置 `OPENSERP_API_KEY` 以使用 OpenSERP Cloud。 API 密钥可在 https://openserp.org/dashboard/keys 获取。 设置 `OPENSERP_BASE_URL` 以指向另一个兼容的 OpenSERP API 基地址。
## 安装
```bash
npm install -g @openserp/mcp
```
您也可以在不安装的情况下运行:
```bash
npx -y @openserp/mcp --stdio
```
## 工具
- `search`
- `mega_search`
- `fast_search`
- `any_search`
- `image_search`
- `mega_image`
- `get_usage`
- `list_engines`
- `extract`
## 快速示例
要求您的 MCP 客户端:
- 搜索 Google 以获取当前文档并返回前 5 个网址。
- 比较 Google 和 Bing 的 SEO 关键词结果。
- 在将网址传递给 LLM 之前,从网址中提取干净的 Markdown。
- 使用 `get_usage` 检查剩余的 Cloud 积分。
## Claude 桌面版
本地 OSS 模式:
```json
{
"mcpServers": {
"openserp": {
"command": "npx",
"args": ["-y", "@openserp/mcp"]
}
}
}
```
云模式:
```json
{
"mcpServers": {
"openserp": {
"command": "npx",
"args": ["-y", "@openserp/mcp"],
"env": {
"OPENSERP_API_KEY": "osk_live_..."
}
}
}
}
```
## Cursor
对于 stdio 使用,添加一个 MCP 服务器条目:
```json
{
"mcpServers": {
"openserp": {
"command": "npx",
"args": ["-y", "@openserp/mcp"],
"env": {
"OPENSERP_API_KEY": "osk_live_..."
}
}
}
}
```
对于远程样式的 HTTP 使用,运行:
```sh
npx -y @openserp/mcp --http --host 127.0.0.1 --port 3333
```
然后将可流式传输的 HTTP MCP 客户端指向:
```text
http://127.0.0.1:3333/mcp
```
仍使用旧 SSE 传输的客户端可以连接到:
```text
http://127.0.0.1:3333/sse
```
## 环境
- `OPENSERP_API_KEY`: 来自 https://openserp.org/dashboard/keys 的 Cloud API 密钥。
- `OPENSERP_BASE_URL`: API 基地址覆盖。
- `OPENSERP_BACKEND`: 可选的后端提示,`oss` 或 `cloud`。
- `OPENSERP_TIMEOUT_MS`: SDK 请求超时(毫秒)。
- `HOST`: HTTP 主机,默认为 `127.0.0.1`。
- `PORT`: HTTP 端口,默认为 `3333`。
## 资源
- [OpenSERP Cloud 文档](https://openserp.org/docs/cloud)
- [MCP 服务器源码](https://github.com/openserpapi/mcp)
- [JavaScript SDK](https://github.com/openserpapi/sdk-js)