article
README
🚀 Firebase 文档 MCP 服务器设置指南
本指南详细介绍了 Firebase 文档 MCP 服务器的设置与使用方法,帮助您高效地进行文档索引和测试工作。
📁 目录布局
docs-mcp
此目录对应 Firebase 文档的索引器,是一个 Go 项目。其主要功能是从指定文件路径抓取并索引 Firebase 文档。
docs-mcp-server
这是模型上下文协议服务器,通过标准输入输出传输方式提供内容服务。
genkit-mcp-tester
这是一个使用 GenKit 实现的 MCP 客户端,专门用于测试 docs-mcp-server。
💻 使用方法
🚀 开始索引
- 设置 API 密钥:我们使用双子星嵌入模型(Gemini embedding model)处理文档,因此需要从 AI 工作室 获取 API 密钥。在终端中调用
export genaikey="APIKEY"来设置密钥。 - 确保输出目录为空:文件将被写入用户主目录下名为
.indexResp的文件夹。Go 会从 Firebase 文档网站抓取文档,以 Markdown 格式保存到磁盘,并在 SQL Lite 数据库中进行索引。若索引失败,会执行重试策略,重新将文档索引为 Markdown 格式。 - 启动索引过程:在
docs-mcp文件夹中调用go run .,这将启动位于main.go文件第 291 行附近列出文件路径的索引过程。
🧪 测试索引器
- 设置 API 密钥:同样需要从 AI 工作室 获取 API 密钥,并在终端中调用
export genaikey="APIKEY"进行设置。 - 切换目录:切换到
docs-mcp-server文件夹。 - 复制索引数据库:通过调用
cp $HOME/.indexResp/db.sqlite .将索引数据库复制到当前docs-mcp-server文件夹。 - 安装依赖项并构建项目:运行
npm ci然后npm run build。构建完成后,通过运行npm run build && npx @modelcontextprotocol/inspector node build/index.js测试项目。这将启动检查程序,并打印出一个 URL,用于查看 STDIO 服务器。 - 连接并测试:在检查程序视图中点击“连接”,然后在工具菜单中选择“List Tools -> find-firebase-doc”,输入请求内容进行测试。
⚠️ 重要提示
作者发现使用 VSCode 的终端时会出现类似问题,因此如果遇到类似问题,请尝试使用系统终端。
🧪 使用 Genkit 进行测试
- 设置 API 密钥:在代码中修改 docs-mcp-server/src/helpers/embeddings.ts 文件内容,将
const genAiKey = process.env.genaikey || "";
修改为
const genAiKey = process.env.genaikey || "MYAPIKEY";
- 切换目录:切换到
genkit-mcp-tester目录。 - 复制索引数据库:通过调用
cp $HOME/.indexResp/db.sqlite .将索引数据库复制到当前genkit-mcp-tester文件夹。 - 安装依赖项并构建项目:运行
npm ci然后npm run build。构建完成后,通过运行npm start启动 Genkit 测试。 - 开始测试:在终端中输入
mcp-tester。 - 输入测试内容:根据提示输入要处理的内容进行测试。
Scan to join WeChat group