Skip to main content

An MCP server to interact with GAM7 for Google Workspace administration

Project description

GAM MCP Server

Python 3.13 License PyPI version

This is a Model Context Protocol (MCP) server that empowers an AI IDE, terminal, or agent to perform administrative actions on Google Workspace using an existing local installation of GAM7.

Prerequisites

  • Python 3.10+ (managed via uv or installed globally)
  • GAM7: Installed and fully authenticated with a client_secrets.json and oauth2.txt/oauth2service.json.
  • uv: The ultra-fast Python package installer and resolver.

Environment Variables

The server relies on the following environment variables to locate and run your local GAM installation:

  • GAM_EXECUTABLE_PATH (optional): The absolute path to your local gam executable. If gam is already in your PATH, you can leave this unset, and the server will execute gam directly.
  • GAM_CFG_DIR (optional): The absolute path to the directory containing your GAM configuration and authentication files (e.g. oauth2.txt, client_secrets.json). If left unset, GAM will use its default configuration paths.

Installation and Usage

To run the server with uv:

uv run src/gamcp/server.py

Usage with Claude Desktop

Add the following to your claude_desktop_config.json:

Important: Claude Desktop often does not inherit your full system path. If you used the standalone installer for uv (which places it in ~/.local/bin or ~/.cargo/bin), you will likely receive a "Failed to spawn process" error. To fix this, replace "uv" or "uvx" in the command field with the absolute path to the executable (e.g., "/Users/YOUR_USER/.local/bin/uvx" or "/opt/homebrew/bin/uvx").

Running locally (Development & Cloning)

If you've cloned this repository locally, you can use uv run:

{
  "mcpServers": {
    "gamcp": {
      "command": "/absolute/path/to/uv",
      "args": [
        "--directory",
        "/absolute/path/to/gamcp",
        "run",
        "src/gamcp/server.py"
      ]
    }
  }
}

Easy installation (Global standard)

If you have published this package to PyPI or installed it globally via uv tool install, you can use uvx directly, which runs isolated tools reliably.

{
  "mcpServers": {
    "gamcp": {
      "command": "/absolute/path_to/.local/bin/uvx",
      "args": [
        "gamcp"
      ]
    }
  }
}

Note: In most cases, the MCP server will automatically detect the standard location GAM or GAMADV-XTD3 installers place their configuration and executable files into. If you installed GAM in a non-standard location, you can additionally supply the GAM_EXECUTABLE_PATH or GAM_CFG_DIR variables in the env dictionary block.

Tools

The server exposes a comprehensive suite of tools organized by functional area:

Core Operations

  • run_gam_command(args: list[str]): Executes raw GAM commands. Provide arguments as a list of strings (e.g., ["info", "domain"]). Returns standard output and standard error.
  • validate_gam_command(args: list[str]): Validates the structure of a proposed GAM command without executing it.

Bulk Processing

  • build_bulk_gam_command(...): Constructs a GAM bulk processing command from structured inputs without executing it.
  • bulk_process_from_sheet(...): Executes a GAM bulk command using a Google Sheet as the data source.

Google Drive

  • migrate_folder_to_shared_drive(...): Migrates a Google Drive folder to a Shared Drive.
  • get_permissions_to_sheet(...): Retrieves file/folder/shared drive permissions and writes them to a Google Sheet.

Calendar

  • transfer_calendar_event(...): Transfers a calendar event from one user to another.

Groups

  • create_collaborative_inbox_group(...): Creates a new Google Group configured as a Collaborative Inbox.
  • get_group_permissions_to_sheet(...): Retrieves group members and their roles, outputting to a Google Sheet.

Users

  • create_gws_user(...): Creates a new Google Workspace user.
  • identify_workspace_entity(identifier: str): Identifies a Workspace entity (user, group, alias, etc.) by its email or ID.

Reports

  • get_gmail_log_events(...): Retrieves Gmail log events and optionally writes them to a Google Sheet.
  • get_user_email_count_to_sheet(...): Retrieves email counts for specific labels across multiple users.

Resources

The server provides the following resources:

  • gam://bulk-processing-guide: A reference guide for constructing GAM bulk processing commands. Includes details on source types, processing modes, column substitution syntax, and batch file directives.

Acknowledgements

This project uses documentation derived from the GAM7 project, which is licensed under the Apache License 2.0. GAM MCP Server is not affiliated with or endorsed by the GAM-team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gamcp-0.1.2.tar.gz (53.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gamcp-0.1.2-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file gamcp-0.1.2.tar.gz.

File metadata

  • Download URL: gamcp-0.1.2.tar.gz
  • Upload date:
  • Size: 53.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for gamcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2fd144802eb50a9dbe43f3b28026f038cef741a6384ffc4634bc13632f4ba486
MD5 34a390cca0ae15b5028afeeb2dadfcff
BLAKE2b-256 7b22ced294e0d5949f7a45cb34646cc36da679a731decb49e4b9d5542b04b94c

See more details on using hashes here.

File details

Details for the file gamcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: gamcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for gamcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e8c2a1dad8bbcd6900d237892270cba7916700ad3d803eb055c3211d3a0f6a5
MD5 947a69be2b3473328f9da6c029c7e8c3
BLAKE2b-256 7d9b3b25961581c4b1a51813e4b9393ab52ea188344e3d22ecdb443bcc40ad1e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page