使用说明
项目简介
本项目是一个基于 Model Context Protocol (MCP) 构建的服务器,它将您的 Google Drive 变成一个可供 LLM 应用访问的上下文数据源。通过此服务器,LLM 可以安全、便捷地搜索和读取您 Google Drive 中的文件,极大地扩展了 LLM 的应用场景。
主要功能点
- Google Drive 文件搜索: 通过 'gdrive_search' 工具,LLM 可以根据关键词在您的 Google Drive 中执行强大的全文搜索,快速找到所需文件。
- Google Drive 文件读取: 通过 'gdrive_read_file' 工具,LLM 可以根据文件 ID 直接读取 Google Drive 中文件的内容,无需手动下载或复制粘贴。
- 智能文件格式处理: 服务器能够自动识别和处理多种 Google Workspace 文件格式,并将其转换为适合 LLM 使用的格式,例如:
- Google 文档 (.gdoc) 转换为 Markdown
- Google 表格 (.gsheet) 转换为 CSV
- Google 幻灯片 (.gslides) 转换为纯文本
- Google 绘图 (.gdraw) 转换为 PNG
- 文本/JSON 文件 转换为 UTF-8 文本
- 其他文件 转换为 Base64 编码
- 安全可靠: 采用 OAuth 2.0 认证流程,确保访问 Google Drive 的安全性,仅请求只读权限,保护您的数据安全。
安装步骤
-
配置 Google Cloud 项目 (详细步骤请参考仓库 README.md 的 "Detailed Google Cloud Setup" 部分):
- 创建 Google Cloud 项目。
- 启用 Google Drive API。
- 配置 OAuth 同意屏幕。
- 创建 OAuth 客户端 ID,并下载 JSON 密钥文件。
- 将下载的 JSON 密钥文件重命名为 'gcp-oauth.keys.json' 并移动到项目根目录下的 'credentials' 文件夹中(如果 'credentials' 文件夹不存在,请先创建)。
-
安装 Node.js 和 npm/yarn: 确保您的系统已安装 Node.js (v16 或更高版本) 和 npm 或 yarn。
-
克隆仓库并安装依赖:
git clone https://github.com/felores/gdrive-mcp-server.git cd gdrive-mcp-server npm install # 或 yarn install npm run build # 构建项目
服务器配置
要将此 MCP 服务器集成到您的 MCP 客户端应用中,您需要在客户端应用中配置服务器信息。以下是一个配置示例,您需要根据实际情况修改 'path/to/gdrive-mcp-server' 为您本地仓库的路径:
{ "mcpServers": { "gdrive": { "command": "node", "args": ["path/to/gdrive-mcp-server/dist/index.js"], "env": { "GOOGLE_APPLICATION_CREDENTIALS": "path/to/gdrive-mcp-server/credentials/gcp-oauth.keys.json", "MCP_GDRIVE_CREDENTIALS": "path/to/gdrive-mcp-server/credentials/.gdrive-server-credentials.json" } } } }
配置参数说明:
- 'server name': 'gdrive' (服务器名称,客户端用此名称引用该服务器)
- 'command': 'node' (启动服务器的命令,这里使用 Node.js 运行)
- 'args': '["path/to/gdrive-mcp-server/dist/index.js"]' (命令参数,指向服务器入口文件 'dist/index.js')
- 'env': 环境变量配置
- 'GOOGLE_APPLICATION_CREDENTIALS': '"path/to/gdrive-mcp-server/credentials/gcp-oauth.keys.json"' (Google Cloud OAuth 客户端密钥 JSON 文件路径)
- 'MCP_GDRIVE_CREDENTIALS': '"path/to/gdrive-mcp-server/credentials/.gdrive-server-credentials.json"' (服务器保存用户认证凭据的文件路径)
请务必将 'path/to/gdrive-mcp-server' 替换为实际的仓库路径。
基本使用方法
-
认证授权: 首次运行服务器前,需要进行 Google Drive 认证授权。在项目根目录下打开终端,运行命令:
node dist/index.js auth按照提示在浏览器中完成 OAuth 认证流程。认证成功后,凭据将保存在 'credentials/.gdrive-server-credentials.json' 文件中。
-
启动服务器: 认证完成后,运行以下命令启动 MCP 服务器:
node dist/index.js服务器成功启动后,您的 MCP 客户端应用即可通过配置的服务器信息连接并使用 'gdrive_search' 和 'gdrive_read_file' 工具访问您的 Google Drive 文件。
-
使用工具: 在 MCP 客户端应用中,您可以调用 'gdrive_search' 工具搜索文件,或调用 'gdrive_read_file' 工具读取文件内容。具体工具的使用方法请参考仓库 README.md 中的 "Example Usage" 部分。
信息
分类
数据库与文件