mcpField
G
google-workspace-cli

google-workspace-cli

github.com/borgheiCloud & DevOps1.0k63 installsUpdated 6d ago
Repository

About google-workspace-cli

A skill for Google Workspace administrators that audits configuration exports, creates API authentication setup guides, and diagnoses common configuration issues. Its tools cover security settings, DNS and transport checks, and integration health.

Key features

  1. 01Workspace security configuration audits
  2. 02OAuth and service-account setup guides
  3. 03API scope and delegation documentation
  4. 04DNS, SSL/TLS, and integration diagnostics
  5. 05Human-readable or JSON output

Use cases

  1. 01Audit exported Workspace settings
  2. 02Prepare API authentication instructions
  3. 03Check DNS and email configuration
  4. 04Diagnose integration or configuration conflicts

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/borghei/claude-skills --skill google-workspace-cli

After installing, type/google-workspace-cliin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
gws-admin-guide.md
scripts/
auth_setup_guide.py
gws_doctor.py
workspace_audit.py

Details

From the project README

Google Workspace CLI

Category: Engineering Domain: Google Workspace Administration

Overview

The Google Workspace CLI skill provides tools for auditing Google Workspace configurations, generating authentication setup documentation, and diagnosing common GWS issues. It helps IT administrators maintain secure, well-configured Workspace environments without needing to navigate complex admin consoles.

Clarify First

Before running, confirm these inputs. If any is unknown or vague, ASK — do not assume:

  • Task — security audit, auth setup guide, or diagnostics (selects workspace_audit.py vs auth_setup_guide.py vs gws_doctor.py)
  • Config export or auth method — the GWS config JSON to audit, or the auth method and scopes for a setup guide (sets --config or --method/--scopes)
  • Output mode — human-readable vs JSON for automation (sets --format json)

Stop rule: ask only the 2-3 that most change the output. If the user says "just draft it," proceed and list your assumptions at the top of the artifact.

Quick Start

# Audit Workspace security configuration
python scripts/workspace_audit.py --config gws-config.json

# Generate auth setup guide
python scripts/auth_setup_guide.py --method oauth --scopes admin,drive

# Run diagnostics
python scripts/gws_doctor.py --check all

# JSON output for automation
python scripts/workspace_audit.py --config gws-config.json --format json

Tools Overview

workspace_audit.py

Audits Google Workspace configuration exports for security best practices.

FeatureDescription
2FA enforcementChecks if 2-step verification is required
Password policyValidates password strength requirements
Sharing settingsReviews external sharing configurations
App accessChecks third-party app access policies
Admin rolesReviews admin role assignments
Mobile managementChecks device management policies
Drive settingsValidates Drive sharing and access controls
auth_setup_guide.py

Generates step-by-step authentication setup documentation for GWS API access.

FeatureDescription
OAuth setupGenerates OAuth 2.0 configuration guide
Service accountCreates service account setup documentation
API scopesLists required scopes for each API
Domain delegationDocuments domain-wide delegation setup
Testing guideProvides verification steps
gws_doctor.py

Diagnostic tool for common Google Workspace configuration issues.

FeatureDescription
DNS checksValidates MX, SPF, DKIM, DMARC records format
SSL/TLSChecks certificate and transport security settings
Integration healthValidates common integration patterns
Config consistencyChecks for conflicting settings
Best practicesCompares against GWS recommended settings

Workflows

Security Audit Workflow
  1. Export config - Export GWS settings to JSON via Admin SDK or manual export
  2. Audit - Run workspace_audit.py against the config file
  3. Review findings - Prioritize critical security gaps
  4. Remediate - Apply recommended settings in Admin Console
  5. Re-audit - Verify changes resolved findings
API Setup Workflow
  1. Plan - Determine which APIs and scopes are needed
  2. Generate guide - Run auth_setup_guide.py with desired method
  3. Follow steps - Create credentials in Google Cloud Console
  4. Configure - Set up domain delegation if needed
  5. Verify - Test API access with provided verification steps
Health Check Workflow
  1. Run diagnostics - Execute gws_doctor.py with all checks
  2. Review results - Check DNS, email, and integration health
  3. Fix issues - Address failures in priority order
  4. Re-check - Verify fixes pass diagnostics
Regular Maintenance
# Monthly security audit
python scripts/workspace_audit.py --config gws-export.json --format json > audit_$(date +%Y%m).json

# Weekly health check
python scripts/gws_doctor.py --check dns,email --format json

Reference Documentation

Common Patterns Quick Reference

Security Priorities
SettingPriorityImpact
2FA enforcementCriticalPrevents account takeover
Password policyCriticalReduces credential attacks
External sharingHighPrevents data leakage
App access controlHighLimits third-party risk
Mobile managementMediumSecures device access
Admin role reviewMediumLimits privilege exposure
DNS Records for Email
RecordPurposeExample
MXEmail routingASPMX.L.GOOGLE.COM
SPFSender verificationv=spf1 include:_spf.google.com ~all
DKIMEmail signingDomain-specific CNAME
DMARCPolicy enforcementv=DMARC1; p=reject; rua=mailto:...
API Scopes
APIScopePurpose
Admin SDKadmin.directory.userUser management
Drivedrive.readonlyFile listing
Gmailgmail.settings.basicEmail settings
Calendarcalendar.readonlyCalendar access
Common Issues
IssueSymptomFix
No 2FAAccount takeover riskEnable 2FA enforcement
Weak passwordsCredential stuffingSet 12+ char minimum
Open sharingData leakageRestrict external sharing
No DMARCEmail spoofingAdd DMARC DNS record
Stale adminsExcessive privilegesReview admin roles quarterly

Comments

Markdown supported