使用说明
Mixpeek MCP服务器
Mixpeek的轻量级、生产友好型模型上下文协议(MCP)服务器:
- 自动加载Mixpeek的OpenAPI规范,并将端点作为MCP工具公开
- 支持本地和托管使用(携带您自己的API密钥)
- 注入
Authorization和X-Namespace标头 - 包括速率限制、超时和编辑日志
- 附带Docker和简单配置
快速入门
- 安装
Python(PyPI):
# global (recommended)
pipx install mixpeek-mcp
# or in a venv
python -m venv .venv && source .venv/bin/activate
pip install mixpeek-mcp
npm(节点):
# run once
npx @mixpeek/mcp
# or install globally
npm i -g @mixpeek/mcp
自制(macOS):
# tap and install (once the tap is live)
brew tap mixpeek/tap https://github.com/mixpeek/homebrew-tap
brew install mixpeek-mcp
# temporary local formula (dev/testing):
brew install --build-from-source Formula/mixpeek-mcp.rb
- 配置(环境或MCP客户端密钥存储)
cp env.sample .env
# edit as needed
环境变量:
MIXPEEK_API_KEY:您的Mixpeek API密钥(如果端点不需要身份验证,则为可选)MIXPEEK_API_BASE:默认值https://api.mixpeek.comMIXPEEK_OPENAPI_URL:默认为<API_BASE>/openapi.json(或/docs/openapi.json)MIXPEEK_NAMESPACE:要通过发送的可选命名空间值X-NamespaceMCP_RATE_MAX_CALLS:默认值20每MCP_RATE_PER_SECONDSMCP_RATE_PER_SECONDS:默认值10MCP_CONNECT_TIMEOUT:默认值5MCP_READ_TIMEOUT:默认值30
- 在本地运行(stdio)
# PyPI
mixpeek-mcp
# from source
python server.py
# npm
mixpeek-mcp
您的MCP客户端(例如Claude Desktop)可以通过stdio连接到此服务器。
码头工人
docker build -t mixpeek-mcp:latest .
docker run --rm -it \
-e MIXPEEK_API_KEY=sk_... \
-e MIXPEEK_NAMESPACE=your_namespace \
mixpeek-mcp:latest
或者pull and run(一旦发布):
docker run --rm -it \
-e MIXPEEK_API_KEY=sk_... \
-e MIXPEEK_NAMESPACE=your_namespace \
ghcr.io/mixpeek/mcp:latest
分布
- npm:
@mixpeek/mcp→https://www.npmjs.com/package/@mixpeek/mcp - PyPI:
mixpeek-mcp→https://pypi.org/project/mixpeek-mcp/(发布待定) - Docker Hub:
mixpeek/mcp(待定推送),GHCR:ghcr.io/mixpeek/mcp(待定推送) - 自制:
mixpeek/tap/mixpeek-mcp(点击要创建的repo)
提交到Docker MCP注册表
我们准备好了 registry.json 与兼容 Docker MCP官方注册表.提交:
- 分叉注册表,并根据他们的CONTRIBUTING指南在相应的目录下创建一个新条目。
- 包括我们的
registry.json(如果您在不同的org/tag下发布,请更新Docker镜像引用)。 - 打开一个PR。批准后,它将出现在MCP目录和Docker Desktop的MCP工具包中。
配置
写保护端点需要:
MIXPEEK_API_KEY:Authorization: Bearer <key>
可选:
MIXPEEK_NAMESPACE:组X-Namespace用于隔离MIXPEEK_API_BASE:默认为https://api.mixpeek.com;测试:https://server-xb24.onrender.comMIXPEEK_OPENAPI_URL:默认为<API_BASE>/openapi.json(或/docs/openapi.json)MCP_RATE_MAX_CALLS/MCP_RATE_PER_SECONDS:简单令牌桶MCP_CONNECT_TIMEOUT/MCP_READ_TIMEOUT:请求超时
运作原理
- 使用以下命令加载OpenAPI规范并将GET/POST JSON端点映射到工具
operationId - 工具参数接受顶级查询参数或
query/body信封 - 使用配置的标头将请求转发到Mixpeek
- 提供小的满列表(可配置)并编辑日志中的机密
测试
单元测试:
pip install -r requirements.txt
pytest -q
现场测试(可选):
export LIVE_MIXPEEK_API_KEY=sk_...
export LIVE_MIXPEEK_OPENAPI_URL=https://server-xb24.onrender.com/docs/openapi.json
export LIVE_MIXPEEK_API_BASE=https://server-xb24.onrender.com
pytest -q tests/test_live_integration.py
与MCP客户端一起使用
- 此服务器使用MCP stdio传输和官方服务器接口,与常见的MCP客户端兼容。
- 启动服务器,然后将MCP客户端指向stdio命令(
mixpeek-mcp).
参考文献
- Mixpeek文档:
https://docs.mixpeek.com/overview/introduction - Mixpeek OpenAPI:
https://api.mixpeek.com/docs/openapi.json - MCP概述:
https://modelcontextprotocol.io/docs/getting-started/intro
备注
- 对于生产托管,前端使用HTTPS,添加SSO/会话发布、每个租户的速率限制以及没有正文/标头的审计日志。保持本地stdio为默认值;稍后可以添加托管HTTP/SSE。