Files
goose/crates/goose-server/ALLOWLIST.md
2025-04-04 16:03:06 -04:00

1.4 KiB

Goose Extension Allowlist

The allowlist feature provides a security mechanism for controlling which MCP commands can be used by goose. By default, goose will let you run any MCP via any command, which isn't always desired.

How It Works

  1. When enabled, Goose will only allow execution of commands that match entries in the allowlist
  2. Commands not in the allowlist will be rejected with an error message
  3. The allowlist is fetched from a URL specified by the GOOSE_ALLOWLIST environment variable and cached while running.

Setup

Set the GOOSE_ALLOWLIST environment variable to the URL of your allowlist YAML file:

export GOOSE_ALLOWLIST=https://example.com/goose-allowlist.yaml

If this environment variable is not set, no allowlist restrictions will be applied (all commands will be allowed).

Allowlist File Format

The allowlist file should be a YAML file with the following structure:

extensions:
  - id: extension-id-1
    command: command-name-1
  - id: extension-id-2
    command: command-name-2

Example:

extensions:
  - id: slack
    command: uvx mcp_slack
  - id: github
    command: uvx mcp_github
  - id: jira
    command: uvx mcp_jira

Note that the command should be the full command to launch the MCP (environment variables are provided for context by goose). Additional arguments will be rejected (to avoid injection attacks)