How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Code Style

This library conforms to PEP 8 style guidelines and enforces an 80 character line width. It's recommended that any contributor run the auto-formatter black. To get started, first install nox and black:

pip install -e ".[dev]"

Then run the formatter on all Python files:

nox -s format

Test changes

1. Add or update unit tests in the tests directory.

2. Run the unit tests for the supported Python versions that are available in your environment:

   nox -s tests*
   

Test using Gemini

To test changes by issuing prompts in Gemini, modify the command for the analytics-mcp entry in your ~/.gemini/settings.json file so Gemini runs the server using your local source files.

Replace PATH_TO_REPO in the following snippet with the path where you cloned the repo:

      "command": "PATH_TO_REPO/.venv/bin/analytics-mcp",

When running the gemini command from a terminal, add the --debug option so Gemini outputs debug information as it processes prompts.

Test from GitHub

After you push changes to GitHub, use pipx to run the server for a specific branch, and use the --no-cache option so pipx gets the latest changes.

Here's an example of an mcpServers entry that runs the latest code from a branch named awesome-feature-42 in this repo:

{
  "mcpServers": {
    "analytics-mcp": {
      "command": "pipx",
      "args": [
        "run",
        "--no-cache",
        "--spec",
        "git+https://github.com/googleanalytics/google-analytics-mcp.git@awesome-feature-42",
        "analytics-mcp"
      ],
      "env": {
        "GOOGLE_APPLICATION_CREDENTIALS": "PATH_TO_CREDENTIALS_JSON",
        "GOOGLE_PROJECT_ID": "YOUR_PROJECT_ID"
      }
    }
  }
}