README
🚀 MCP Google Contacts Server
MCP Google Contacts Server 是一款强大的工具,可与 Google Contacts API 交互,帮助您高效管理联系人与 Google Workspace 目录。借助该服务器,您能轻松执行创建、更新、删除联系人等操作,还可搜索其他联系人。
🚀 快速开始
MCP Google Contacts Server 可让您轻松与 Google Contacts API 交互,管理您的联系人和 Google Workspace 目录。使用前,请确保您的 API 密钥具备相应权限。
✨ 主要特性
- 列出所有联系人:可获取所有 Google Contacts,也能按名称进行过滤。
- 获取特定联系人信息:通过资源名称或电子邮件地址,就能检索详细信息。
- 创建新联系人:方便添加新的联系人信息。
- 更新现有联系人:可灵活修改现有联系人的信息。
- 删除联系人:能从 Google Contacts 中删除指定的联系人。
- 搜索 contacts:支持通过姓名、电子邮件或电话号码搜索特定联系人。
- 列出 Google Workspace 用户:可获取组织目录中的所有用户。
- 搜索目录成员:能执行目标搜索以查找特定的目录成员。
- 获取其他 contacts:可检索您互动过但未添加到 Contacts 中的人。
📚 详细文档
工具详细描述
list_contacts
列出所有您的 Google 联系人,或按名称过滤。
参数:
| 参数 | 详情 |
|------|------|
| name_filter(可选) | 用于按名称筛选联系人的字符串 |
| max_results(可选) | 要返回的最大联系人数,默认为 100 |
示例:
list_contacts(name_filter="John", max_results=10)
get_contact
检索特定联系人详细信息。
参数:
| 参数 | 详情 |
|------|------|
| identifier | 资源名称(people/*)或电子邮件地址 |
示例:
get_contact("john.doe@example.com")
# 或者
get_contact("people/c12345678901234567")
create_contact
创建新的 Google 联系人。
参数:
| 参数 | 详情 |
|------|------|
| given_name | 联系人的姓 |
| family_name(可选) | 联系人的名 |
| email(可选) | 电子邮件地址 |
| phone(可选) | 电话号码 |
示例:
create_contact(given_name="Jane", family_name="Smith", email="jane.smith@example.com", phone="+1-555-123-4567")
update_contact
更新现有联系人信息。
参数:
| 参数 | 详情 |
|------|------|
| resource_name | 联系人资源名称(people/*) |
| given_name(可选) | 更新的姓 |
| family_name(可选) | 更新的名 |
| email(可选) | 更新的电子邮件地址 |
| phone(可选) | 更新的电话号码 |
示例:
update_contact(resource_name="people/c12345678901234567", email="new.email@example.com")
delete_contact
删除指定联系人。
参数:
| 参数 | 详情 |
|------|------|
| resource_name | 要删除的联系人资源名称(people/*) |
示例:
delete_contact(resource_name="people/c12345678901234567")
search_contacts
按姓名、电子邮件或电话号码搜索 contacts。
参数:
| 参数 | 详情 |
|------|------|
| query | 用于搜索的查询词 |
| max_results(可选) | 要返回的最大结果数,默认为 10 |
示例:
search_contacts(query="john", max_results=5)
list_workspace_users
列出您组织目录中的所有 Google Workspace 用户。
参数:
| 参数 | 详情 |
|------|------|
| query(可选) | 用于查找特定用户的查询词 |
| max_results(可选) | 要返回的最大结果数,默认为 50 |
示例:
list_workspace_users(query="engineering", max_results=25)
search_directory
执行目标搜索以查找特定的目录成员。
参数:
| 参数 | 详情 |
|------|------|
| query | 用于搜索的查询词 |
| max_results(可选) | 要返回的最大结果数,默认为 10 |
示例:
search_directory(query="Marketing", max_results=20)
get_other_contacts
检索您互动过但未添加到 Contacts 中的人。
参数:无
示例:
get_other_contacts()
🔧 技术细节
要使用此服务器,您需要具备以下权限:
- 读取和写入 Google 联系人
- 管理 Google Workspace 目录
请确保您的 API 密钥具有适当的权限。
💡 故障排除指南
常见问题解答
⚠️ 重要提示
若在使用过程中遇到问题,可参考以下常见问题解答。
💡 使用建议
请仔细核对输入信息,确保 API 密钥权限正确。
-
如何获取我的 API 密钥? 您可以在 Google Cloud Console 中找到并生成新的 API 密钥。
-
我收到权限错误怎么办? 确保您的 API 密钥具有所需的权限。您可能需要启用 Google 联系人 API 和 Google Workspace 目录 API。
-
无法连接到服务器? 检查您的网络连接,确保没有防火墙阻止与 Google 服务的通信。
-
如何解决 404 错误? 确保您提供的资源名称或电子邮件地址是正确的,并且格式正确。
📄 许可证
此项目遵循 MIT 许可证。我们欢迎社区贡献,但请确保遵守代码规范并提供详细的提交信息。
如需贡献,请访问我们的 GitHub 仓库:MCP Google Contacts Server
Scan to contact