关于 Imagin.studio Api Docs
Imagin.studio Api Docs 是面向编码助手的 MCP 服务,通过语义搜索提供 IMAGIN.studio 的 CDN、API 和集成文档。它在本地建立并自动更新索引,无需 API 密钥或外部服务。
主要功能
- 01语义搜索 IMAGIN 文档
- 02本地构建向量索引
- 03索引自动更新
- 04无需 API 密钥
适用场景
- 01查找 CDN 配置说明
- 02检索 API 端点和参数
- 03查询集成指南
MCP 相关
该 MCP 服务向客户端提供 `search_docs` 工具,用于检索 IMAGIN.studio 文档。文档索引在本地构建和更新。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
1收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| query | string | 是 | 自然语言搜索查询。使用具体的技术术语,而 不要使用含糊的描述。好例:“CDN cache invalidation headers”。 反例:“caching stuff”。 |
| top_k | integer | 否 | 返回结果数(1-20,默认值为 5)。针对具体查询使用 1-3, 一般问题使用 5,广泛研究使用 10-20。 |
详细介绍
IMAGIN.studio API 文档 MCP 服务
让你的 AI 编码助手即时访问完整的 IMAGIN.studio 文档——CDN 配置、API 参考、集成指南等。
一个工具。一条命令。适用于所有主流 AI 编码助手。
快速开始
将以下内容粘贴到你的 Agent 的 MCP 配置中:
{
"mcpServers": {
"imagin-docs": {
"command": "uvx",
"args": ["imagin-studio-api-docs-mcp"]
}
}
}
或者直接向你的 AI 助手询问:
安装此 MCP 服务:https://pypi.org/project/imagin-studio-api-docs-mcp/
工作原理
- 安装 —
uvx imagin-studio-api-docs-mcp(无需克隆、无需 venv、无需配置) - 建立索引 — 首次运行时,克隆文档并构建本地向量索引(约 30 秒)
- 搜索 — 你的 AI 助手调用
search_docs查找相关文档 - 保持最新 — 上游文档更改时,索引会自动更新
所有操作都在本地运行。无需 API 密钥。无需外部服务。
支持的 Agent
| Agent | 配置位置 |
|---|---|
| Claude Code | 项目根目录中的 .mcp.json |
| Claude Desktop | claude_desktop_config.json |
| Cursor | Settings > Tools & MCP |
| Windsurf | ~/.codeium/windsurf/mcp_config.json |
| VS Code + Copilot | .vscode/mcp.json |
| Cline | MCP 服务面板 |
| Zed | ~/.config/zed/settings.json |
各 Agent 的详细设置说明,请参阅 PyPI 上的完整设置指南。
替代方案:npx
如果你的 Agent 找不到 uvx(Claude Desktop 和 Cursor 等 GUI 应用中很常见):
{
"mcpServers": {
"imagin-docs": {
"command": "npx",
"args": ["-y", "@imagin.studio/api-docs-mcp"]
}
}
}
你可以询问的内容
安装后,可以尝试以下提示词:
- “在 IMAGIN 文档中搜索 CDN 缓存失效相关内容”
- “如何在 IMAGIN 中设置自定义域名?”
- “查找用于图像转换的 API 端点”
- “IMAGIN.studio 支持哪些图像格式?”
软件包
| 注册表 | 软件包 | 安装 |
|---|---|---|
| PyPI | imagin-studio-api-docs-mcp | uvx imagin-studio-api-docs-mcp |
| npm | @imagin.studio/api-docs-mcp | npx -y @imagin.studio/api-docs-mcp |
许可证
Apache License 2.0 — 详见 LICENSE。
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。