README
🚀 Gemini Docs MCP Server
Gemini Docs MCP Server 是一个本地标准输入输出(STDIO)的 MCP 服务器,它提供了搜索和检索 Google Gemini API 文档的工具。借助该服务器,用户能够高效地查找所需的文档内容,提升开发效率。
🚀 快速开始
Gemini Docs MCP Server 为开发者提供了便捷的途径来搜索和获取 Google Gemini API 文档。它具备全文搜索、获取文档能力列表、查看当前模型文档等功能,并且会在服务器启动时自动更新文档。
✨ 主要特性
- 搜索文档:可对所有 Gemini 文档页面进行全文搜索。
- 获取能力信息:列出可用的文档页面,或检索特定页面的内容。
- 获取当前模型:快速访问当前 Gemini 模型的文档。
- 自动更新:在服务器启动时抓取并更新文档。
📦 安装指南
选项 1:使用 uvx(推荐)
你可以使用 uvx 直接运行服务器,无需显式安装。这是最简单的启动方式。
uvx --from git+https://github.com/philschmid/gemini-api-docs-mcp gemini-docs-mcp
选项 2:直接从 GitHub 安装
你可以使用 pip 直接从 GitHub 安装该软件包。
pip install git+https://github.com/philschmid/gemini-api-docs-mcp.git
选项 3:手动安装(用于开发)
git clone https://github.com/philschmid/gemini-api-docs-mcp.git
cd gemini-api-docs-mcp
pip install -e .
cd ..
rm -rf gemini-api-docs-mcp
💻 使用示例
基础用法
如果你通过 pip 安装(选项 2 或 3),可以使用以下命令运行服务器:
gemini-docs-mcp
这将通过标准输入输出启动 MCP 服务器。服务器会立即开始摄取文档,首次运行时可能需要一些时间。
高级用法
配置
数据库默认存储在 ~/.mcp/gemini-api-docs/database.db。你可以通过设置 GEMINI_DOCS_DB_PATH 环境变量来覆盖此路径。
与 MCP 客户端配合使用
配置你的 MCP 客户端以运行 gemini-docs-mcp 命令。
{
"mcpServers": {
"gemini-docs": {
"command": "uvx",
"args": ["--from", "git+https://github.com/philschmid/gemini-api-docs-mcp", "gemini-docs-mcp"]
}
}
}
{
"mcpServers": {
"gemini-docs": {
"command": "gemini-docs-mcp"
}
}
}
📚 详细文档
工作原理
- 摄取阶段:服务器启动时,会获取
https://ai.google.dev/gemini-api/docs/llms.txt以获取所有可用文档页面的列表。 - 处理阶段:随后并发地获取并处理每个页面,提取文本内容。
- 索引阶段:处理后的内容存储在本地 SQLite 数据库中,并使用全文搜索(FTS5)索引,以便高效查询。
- 搜索阶段:当你使用
search_documentation工具时,服务器会查询该 SQLite 数据库以找到最相关的文档页面。
工具说明
search_documentation(queries: list[str]):对给定的查询列表(最多 3 个)在 Gemini 文档中进行全文搜索。get_capability_page(capability: str = None):获取能力列表或特定能力的内容。get_current_model():获取当前 Gemini 模型的文档。
测试结果
我们运行了全面的评估工具,以确保 MCP 服务器提供准确和最新的代码示例。测试涵盖了 Python 和 TypeScript SDK。
| 指标 | 值 | | ---- | ---- | | 总测试数 | 117 | | 通过数 | 114 | | 失败数 | 3 |
最后更新时间:2025-11-03 13:29:01
你可以在 tests/result.json 中找到详细的测试结果。
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫