gws-admin-mcp

io.github.antct11由 GitHub 账号 antct11 发布v0.3.0更新于 Oct 25, 2026

Safe Google Workspace admin for AI agents: read-only by default, confirm-gated deletes, audit log.

概览

AI 生成的概览

一个本地 MCP 服务器,为 AI 助手提供安全的 Google Workspace 管理控制台:默认只读,破坏性操作需二次确认,并留有审计日志。

可以做什么
列出并查看用户、群组、成员、组织部门、角色、域名、客户信息与群组设置,列表调用支持 Admin SDK 搜索语法并自动分页。查看审计日志活动以及按用户或按客户的用量报告。启用写入模式后,可创建、更新、暂停、重置密码、移动或删除用户,并管理群组、组织部门、角色分配与群组设置。列出移动设备与 ChromeOS 设备,写入模式下可移动设备或执行擦除、取消配置操作。
适用场景
适合让助手回答 Google Workspace 域内的问题,例如长期未登录的用户或群组成员,或在变更窗口内执行受控的管理变更。默认只读模式适合日常查询,写入模式用于有监督的明确变更。
运行要求
在本地运行,需要 Node.js 20 或更高版本。需要一个启用 Admin SDK 与 Groups Settings API 的 Google Cloud 项目、服务账号 JSON 密钥,并为该服务账号的客户端 ID 授予域范围委派。需在 config.json 的 delegatedAdmin 或 DELEGATED_ADMIN 变量中指定要模拟的 Workspace 超级管理员;还会读取 GOOGLE_SA_KEY 与 CUSTOMER_ID。仅支持桌面版 MCP 客户端。
安装前请注意
服务账号密钥可模拟拥有全组织权限的超级管理员,应避免提交到版本库、限制权限并定期轮换。只有以 --allow-write 或 GWS_ADMIN_ALLOW_WRITE=1 启动时才存在写入工具,删除、擦除与取消配置还需将 confirm 设为 true。写入操作会更改、暂停或删除真实账号与设备。除非设置 GWS_ADMIN_AUDIT=0,每次工具调用都会写入本地审计文件。数据仅发送给 Google API。

安装

在 SourceWeft 中

  1. 打开 控制台中的 gws-admin-mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

gws-admin-mcp

A local Model Context Protocol (MCP) server that gives your AI agent (Cursor, Claude Desktop, or any MCP client) a safe Google Workspace admin console. It talks to the Admin SDK (Directory, Reports, Groups Settings) through a service account with domain-wide delegation, so the agent can answer questions like "which users haven't logged in for 90 days?" or "who is in the Finance group?" — and, only when you explicitly allow it, make changes.

MCP client ──stdio──► gws-admin-mcp ──service account JWT (impersonates an admin)──► admin.googleapis.com / groupssettings.googleapis.com

Runs entirely on your machine. No third-party service, no telemetry, no data leaves your laptop except the Google API calls themselves.

Safety model

This server assumes the agent driving it is fallible. Three layers:

  1. Read-only by default. Out of the box only the 17 read tools are registered — write tools are not hidden behind a runtime check, they simply do not exist in the tool list, so the agent cannot call them. Mutations require starting the server with --allow-write (or GWS_ADMIN_ALLOW_WRITE=1).
  2. Confirm gate on destructive calls. Even with writes enabled, the irreversible operations — users_delete, groups_delete, orgunits_delete, role_assignment_delete, mobile device wipe actions, and ChromeOS deprovision — are refused unless the call includes "confirm": true. The agent has to make the destructive intent explicit a second time.
  3. Audit log. Every tool call is appended as JSON lines to ~/.config/gws-admin-mcp/audit.log (mode 600), with passwords and secrets redacted. Disable with GWS_ADMIN_AUDIT=0 if you must.

Recommended pattern: run the read-only instance permanently, and start a second, write-enabled instance only for the duration of a change window.

Tools (40 total; 17 in read-only mode)

AreaRead-only toolsWrite tools (require --allow-write)
Usersusers_list, users_getusers_create, users_update, users_suspend, users_unsuspend, users_reset_password, users_make_admin, users_move_ou, users_delete*
Groupsgroups_list, groups_get, groups_list_membersgroups_create, groups_update, groups_delete*, groups_add_member, groups_remove_member, groups_update_member
Org unitsorgunits_list, orgunits_getorgunits_create, orgunits_update, orgunits_delete*
Rolesroles_list, role_assignments_listrole_assignment_create, role_assignment_delete*
Domains / customerdomains_list, customer_get—
Devicesdevices_list_mobile, devices_list_chromeosdevices_action_mobile, devices_action_chromeos, devices_move_chromeos
Reportsreports_activities (audit log), reports_usage_user, reports_usage_customer—
Group settingsgroupsettings_getgroupsettings_update

* Destructive — additionally requires "confirm": true in the call (device tools only for wipe/deprovision actions).

List tools auto-paginate up to a maxResults cap, and users_list supports the full Admin SDK search syntax (orgUnitPath='/Sales', isAdmin=true, email:jdoe*, ...).

Requirements

  • Node.js >= 20
  • Super-admin access to a Google Workspace domain (to grant domain-wide delegation)
  • A Google Cloud project (free — the Admin SDK has no usage cost)

Google Cloud setup

You need a service account whose key the server uses to impersonate a Workspace super-admin. Two paths:

Path A — scripted (needs gcloud)

bash
gcloud auth login [email protected]scripts/setup-service-account.sh [email protected] your-project-id

The script creates/reuses the project, enables the Admin SDK + Groups Settings APIs, creates the service account, writes the key and config to ~/.config/gws-admin-mcp/, and prints the client ID + scope string for the final manual step (step 5 below — Google provides no API for that part).

Path B — manual (Cloud console)

  1. Create a project at console.cloud.google.com (or reuse one dedicated to admin tooling).
  2. Enable APIs: Admin SDK API and Groups Settings API (APIs & Services → Library).
  3. Create a service account (IAM & Admin → Service Accounts → Create). No project-level IAM roles are needed — its power comes entirely from the delegation grant in the next steps.
  4. Create a JSON key for it (Keys tab → Add key → JSON) and save it as ~/.config/gws-admin-mcp/service-account.json with chmod 600.
  5. Grant domain-wide delegation — this is the step people miss:
    • Copy the service account's OAuth 2 client ID (a long number, shown on the service account details page).
    • In the Admin console (admin.google.com): Security → Access and data control → API controls → Domain-wide delegation → Add new.
    • Paste the client ID, and paste this exact scope list as one comma-separated line:
https://www.googleapis.com/auth/admin.directory.user,https://www.googleapis.com/auth/admin.directory.group,https://www.googleapis.com/auth/admin.directory.group.member,https://www.googleapis.com/auth/admin.directory.orgunit,https://www.googleapis.com/auth/admin.directory.rolemanagement,https://www.googleapis.com/auth/admin.directory.domain.readonly,https://www.googleapis.com/auth/admin.directory.customer.readonly,https://www.googleapis.com/auth/admin.directory.device.mobile,https://www.googleapis.com/auth/admin.directory.device.chromeos,https://www.googleapis.com/auth/admin.reports.audit.readonly,https://www.googleapis.com/auth/admin.reports.usage.readonly,https://www.googleapis.com/auth/apps.groups.settings
  1. Tell the server which admin to impersonate. Create ~/.config/gws-admin-mcp/config.json:
json
{  "delegatedAdmin": "[email protected]",  "customerId": "my_customer"}

delegatedAdmin must be a super-admin of the domain. my_customer resolves to that admin's own organization.

Environment variables override the config files: GOOGLE_SA_KEY (key path), DELEGATED_ADMIN, CUSTOMER_ID, GWS_ADMIN_CONFIG_DIR (alternate config directory). See .env.example.

Build and verify

bash
npm installnpm run buildnode dist/cli.js doctor

doctor checks the key, mints a delegated token, and runs sample reads against users, domains, roles, and the audit reports API. All four should say PASS. Then optionally:

bash
npm run smoke   # spawns the real server over stdio, checks tool registration + live reads

MCP client configuration

Cursor (~/.cursor/mcp.json)

Read-only — the recommended default:

json
{  "mcpServers": {    "gws-admin": {      "command": "node",      "args": ["/ABSOLUTE/PATH/TO/gws-admin-mcp/dist/cli.js", "serve"]    }  }}

Write-enabled (use deliberately, ideally as a second entry you toggle on):

json
{  "mcpServers": {    "gws-admin-write": {      "command": "node",      "args": ["/ABSOLUTE/PATH/TO/gws-admin-mcp/dist/cli.js", "serve", "--allow-write"]    }  }}

Claude Desktop (claude_desktop_config.json)

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json · Windows: %APPDATA%\Claude\claude_desktop_config.json

json
{  "mcpServers": {    "gws-admin": {      "command": "node",      "args": ["/ABSOLUTE/PATH/TO/gws-admin-mcp/dist/cli.js", "serve"]    }  }}

Restart the client after editing. You should see the gws-admin server with 17 tools (read-only) or 40 (write-enabled).

Troubleshooting

SymptomCause / fix
unauthorized_client when minting a tokenThe domain-wide delegation grant is missing, uses the wrong client ID, or its scope list doesn't cover every scope the server requests. Re-paste the full scope string from above against the SA's OAuth2 client ID. Grants can take a few minutes to propagate.
Service-account key not found at ...Put the JSON key at ~/.config/gws-admin-mcp/service-account.json or set GOOGLE_SA_KEY to its path.
DELEGATED_ADMIN ... is not setAdd delegatedAdmin to config.json or set the DELEGATED_ADMIN env var.
403 Not Authorized to access this resource/apiThe impersonated user is not a super-admin, or the Admin SDK API isn't enabled in the Cloud project.
404 from Groups Settings callsThe Groups Settings API isn't enabled in the project (it's separate from the Admin SDK).
Write tools don't appear in the clientWorking as intended — start the server with --allow-write or GWS_ADMIN_ALLOW_WRITE=1.
A delete/wipe call returns Refused: ... destructive/irreversibleWorking as intended — re-issue the call with "confirm": true.
Client shows the server as failed on startupRun node dist/cli.js doctor in a terminal; it prints the exact failing check. Also confirm the args path in your MCP config is absolute.

Security notes

  • The service-account key impersonates a super-admin with org-wide power. Treat service-account.json like a domain-admin password: keep it out of git (this repo's .gitignore already excludes key files, .env, and config.json), keep it chmod 600, and rotate it periodically.
  • Prefer a dedicated Cloud project for this service account so the key is easy to audit and revoke.
  • Keep the permanent instance read-only. Enable writes in a separate instance only when you actually intend to change things, and turn it off after.

License & purchase

This repository is source-available, not open source: the code is public so you can read and audit every line before trusting it with a super-admin credential, but using it requires a license.

See LICENSE for the exact terms (no redistribution, no offering it as a hosted service).

来源:README.md,提交 e941550

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.3.0最新Sep 16, 2026

评分

已满足适用检查项的 40%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。