aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-18 06:34:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
c12f02bb82b4c6761aba3ec61485036b8f79bd0c
goose/crates/goose-server/ALLOWLIST.md
Michael Neale c0b79873b5 allowlist blocks and shift SSE to warning (#2445)
2025-05-07 09:44:52 -04:00

2.1 KiB
Raw Blame History

IMPORTANT: currently GOOSE_ALLOWLIST is used in main.ts in ui/desktop, and not in goose-server. The following is for reference in case it is used on the server side for launch time enforcement.

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).

Bypassing the Allowlist

In certain development or testing scenarios, you may need to bypass the allowlist restrictions. You can do this by setting the GOOSE_ALLOWLIST_BYPASS environment variable to true:

# For the GUI, you can have it show a warning instead of blocking (but it will always show a warning):
export GOOSE_ALLOWLIST_WARNING=true

When this environment variable is set to true (case insensitive), the allowlist check will be bypassed and all commands will be allowed, even if the GOOSE_ALLOWLIST environment variable is set.

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)