README
🚀 Google Drive MCP 服务器
这是一个功能强大的模型上下文协议 (MCP) 服务器,它实现了与 Google Drive 的无缝集成,让 AI 模型能够在 Google Drive 中进行文件搜索、列表查看以及内容读取操作。
🚀 快速开始
前置条件
- Node.js(v14 或更高版本)
- npm(5.7 或更高版本)
安装
npm install gdrive-mcp-server
使用示例
基础用法
import { GDriveMCP } from 'gdrive-mcp-server';
async function main() {
const gdrive = new GDriveMCP({
credentialsPath: './credentials.json',
tokenPath: './token.json'
});
// 搜索文件
const files = await gdrive.search({ query: 'quarterly report' });
console.log('搜索结果:', files);
// 读取文件内容
const contents = await gdrive.read('your-file-id');
console.log('文件内容:', contents);
}
main().catch(console.error);
✨ 主要特性
工具
1. gdrive_search
可在你的 Google Drive 中利用强大的全文搜索功能来搜索文件。
- 输入:
{ "query": "string (你的搜索查询)" } - 输出:包含以下信息的文件列表:
- 文件名
- MIME 类型
- 文件 ID
- 最后修改时间
- 文件大小
2. gdrive_read_file
能使用 Google Drive 文件 ID 直接读取文件内容。
- 输入:
{ "file_id": "string (Google Drive 文件 ID)" } - 输出:以适当格式转换的文件内容
自动文件格式处理
服务器可智能处理不同的 Google Workspace 文件类型:
- 📝 Google Docs → Markdown
- 📊 Google Sheets → CSV
- 📊 Google Presentations → 文本
- 🎨 Google Drawings → PNG
- 📄 文本/JSON 文件 → UTF-8 文本
- 📦 其他文件 → Base64 编码
📦 安装指南
创建 Credentials 文件
需在 credentials.json 中添加你的 Google Drive 凭据:
{
"type": "service_account",
"project_id": "your-project-id",
"private_key_id": "your-private-key-id",
"private_key": "your-private-key",
"client_email": "your-client-email",
"token_uri": "https://oauth2.googleapis.com/token"
}
认证流程
- 使用你的 Google 账户访问 Google Cloud Console
- 创建一个新的项目或选择现有项目。
- 启用 Drive API v3 API。
- 创建服务账号并下载 JSON 密钥文件(即
credentials.json)。
授权
运行你的应用以获取必要的 OAuth 令牌:
node src/auth.js
📚 详细文档
配置
创建 Credentials 文件
在 credentials.json 中添加你的 Google Drive 凭据,具体格式如下:
{
"type": "service_account",
"project_id": "your-project-id",
"private_key_id": "your-private-key-id",
"private_key": "your-private-key",
"client_email": "your-client-email",
"token_uri": "https://oauth2.googleapis.com/token"
}
认证流程
- 用你的 Google 账户访问 Google Cloud Console。
- 可选择创建新项目或使用现有项目。
- 启用 Drive API v3 API。
- 创建服务账号并下载 JSON 密钥文件(即
credentials.json)。
授权
运行以下命令来获取必要的 OAuth 令牌:
node src/auth.js
安全
- 所有敏感凭证都存储在
credentials目录中。 - OAuth 凭证和令牌不在版本控制中。
- 对 Google Drive 采用只读访问方式。
- 使用安全的 OAuth 2.0 认证流程。
贡献
欢迎大家贡献代码!你可以随意提交 Pull Request。
授权协议
此 MCP 服务器遵循 MIT 许可证进行分发。你可以查看 LICENSE 文件以获取详细信息。
故障排除
若你遇到问题,可按以下步骤排查:
- 验证你的 Google Cloud 项目设置。
- 确保所有所需的 OAuth 范围已启用。
- 检查凭证是否正确放置在
credentials目录中。 - 验证 Google Drive 中的文件权限和访问权限。
Scan to contact