Tool Permissions

About Tool Permissions

Auggie CLIs tool permission system provides fine-grained control over what actions the agent can perform in your environment. This security layer ensures that Auggie only executes approved operations, protecting your codebase and system from unintended changes. Tool permissions are especially important when:

Running Auggie in production environments
Working with sensitive codebases
Enforcing organizational security policies
Using Auggie in automated workflows

How Permissions Work

When Auggie attempts to use a tool, the permission system:

Checks for matching rules in your configuration
Applies the first matching rule based on tool name and optional patterns
Rules are evaluated top-down - first match wins
Prompts for approval when set to ask-user mode (interactive only)

Permission Flow

Copy

Ask AI

Tool Request → Check Rules → Apply Permission → Execute/Deny → Log Decision

Notes on Unmatched Tools

Rules are evaluated in order from top to bottom
The first matching rule determines the permission
If no rules match, the CLI follows its implicit runtime behavior
Configure explicit rules for all tools you want to control

Configuration Files

Tool permissions are configured through the settings.json located in ~/.augment/settings.json as personal settings that apply to all your projects.

Basic Configuration

Creating Rules

Rules define permissions for specific tools. Each rule can specify:

Tool name - The specific tool to control
Permission type - allow, deny, or ask-user
Optional patterns - For shell commands, use regex matching

Basic Rule Structure

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "launch-process", "permission": { "type": "deny" } },
    { "toolName": "view", "permission": { "type": "allow" } }
  ]
}

Allow List Configuration

Create an explicit allow list by only allowing specific tools:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "view", "permission": { "type": "allow" } },
    { "toolName": "codebase-retrieval", "permission": { "type": "allow" } },
    { "toolName": "grep-search", "permission": { "type": "allow" } },
    { "toolName": "github-api", "permission": { "type": "allow" } }
  ]
}

This configuration explicitly allows only the listed tools. Tools not in this list will follow the CLI’s implicit behavior.

Block List Configuration

Create a block list by explicitly denying specific dangerous tools:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "remove-files", "permission": { "type": "deny" } },
    { "toolName": "kill-process", "permission": { "type": "deny" } },
    { "toolName": "launch-process", "shellInputRegex": "^(rm|sudo|shutdown|reboot)", "permission": { "type": "deny" } }
  ]
}

This configuration blocks specific dangerous operations. Tools not explicitly denied will follow the CLI’s implicit behavior.

Mix and Match Configuration

Combine allow, deny, and ask-user rules for fine-grained control:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "view", "permission": { "type": "allow" } },
    { "toolName": "codebase-retrieval", "permission": { "type": "allow" } },
    { "toolName": "grep-search", "permission": { "type": "allow" } },

    { "toolName": "str-replace-editor", "permission": { "type": "ask-user" } },
    { "toolName": "save-file", "permission": { "type": "ask-user" } },

    { "toolName": "launch-process", "shellInputRegex": "^(npm test|npm run lint|git status|git diff)", "permission": { "type": "allow" } },
    { "toolName": "launch-process", "shellInputRegex": "^(rm -rf|sudo|chmod 777)", "permission": { "type": "deny" } },
    { "toolName": "launch-process", "permission": { "type": "ask-user" } },

    { "toolName": "remove-files", "permission": { "type": "deny" } }
  ]
}

This configuration provides fine-grained control with different permission levels based on tool risk and usage patterns.

Available Tools

Process Management

Tool	Description
`launch-process`	Execute shell commands and scripts
`read-process`	Read output from running processes
`write-process`	Send input to running processes
`list-processes`	List all active processes
`kill-process`	Terminate running processes

File Operations

Tool	Description
`view`	Read file contents
`str-replace-editor`	Edit files with find/replace
`save-file`	Create or overwrite files
`remove-files`	Delete files from the filesystem
`codebase-retrieval`	Search codebase with context engine
`grep-search`	Search files with regex patterns

External Services

Tool	Description
`github-api`	GitHub API operations
`linear`	Linear issue tracking
`notion`	Notion workspace access
`supabase`	Supabase database operations
`web-search`	Web search queries
`web-fetch`	Fetch web page content

MCP Server Tools

MCP tools follow the pattern {tool-name}_{server-name}:

Example: query_database-mcp
Truncated to 64 characters if longer
Treated like any other tool for permissions

Advanced Rules

Shell Command Filtering

Control which shell commands can be executed using regex patterns:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "launch-process", "shellInputRegex": "^(ls|pwd|echo|cat|grep)\\s", "permission": { "type": "allow" } },
    { "toolName": "launch-process", "permission": { "type": "deny" } }
  ]
}

This configuration:

Allows only safe commands (ls, pwd, echo, cat, grep)
Denies all other shell commands
Rules are evaluated in order - first match wins

Event-Based Permissions

Control when permission checks occur:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "github-api", "eventType": "tool-response", "permission": { "type": "allow" } }
  ]
}

Event types:

tool-call (default) - Check before tool execution
tool-response - Check after execution but before returning results to agent

Interactive Approval

When using ask-user mode in interactive sessions, Auggie displays approval prompts:

Copy

Ask AI

🔒 Tool Approval Required
─────────────────────────
Tool: launch-process
Command: npm install express

[A]llow once  [D]eny  [Always allow]  [Never allow]

Keyboard Shortcuts

Key	Action
`A`	Allow this specific request
`D`	Deny this specific request
`Y`	Always allow this tool
`N`	Never allow this tool
`Esc`	Cancel and deny request

In non-interactive mode (—print), ask-user permissions default to deny for security.

Common Configurations

Read-Only Mode

Allow only read operations, perfect for code review and analysis:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "view", "permission": { "type": "allow" } },
    { "toolName": "codebase-retrieval", "permission": { "type": "allow" } },
    { "toolName": "grep-search", "permission": { "type": "allow" } },
    { "toolName": "web-search", "permission": { "type": "allow" } },
    { "toolName": "web-fetch", "permission": { "type": "allow" } },
    { "toolName": "str-replace-editor", "permission": { "type": "deny" } },
    { "toolName": "save-file", "permission": { "type": "deny" } },
    { "toolName": "remove-files", "permission": { "type": "deny" } },
    { "toolName": "launch-process", "permission": { "type": "deny" } }
  ]
}

Development Mode

Add safety guards for potentially dangerous operations:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "remove-files", "permission": { "type": "ask-user" } },
    {
      "toolName": "launch-process",
      "shellInputRegex": "^(rm|sudo|chmod)\\s",
      "permission": { "type": "ask-user" }
    }
  ]
}

CI/CD Pipeline

Restrictive settings for automated workflows:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "view", "permission": { "type": "allow" } },
    { "toolName": "str-replace-editor", "permission": { "type": "allow" } },
    { "toolName": "save-file", "permission": { "type": "allow" } },
    {
      "toolName": "launch-process",
      "shellInputRegex": "^(npm test|npm run lint|jest)\\s",
      "permission": { "type": "allow" }
    },
    { "toolName": "remove-files", "permission": { "type": "deny" } },
    { "toolName": "launch-process", "permission": { "type": "deny" } }
  ]
}

Custom Policies

Webhook Validation

Use external services to validate tool requests:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "github-api", "permission": { "type": "webhook-policy", "webhookUrl": "https://api.company.com/validate-tool" } }
  ]
}

The webhook receives a POST request with the following JSON payload:

Copy

Ask AI

{
  "tool-name": "github-api",
  "event-type": "tool-call",
  "details": { /* tool-specific data, see below */ },
  "timestamp": "2025-01-01T02:41:40.580Z"
}

Payload fields:

tool-name: The name of the tool being invoked
event-type: Either "tool-call" (before execution) or "tool-response" (after execution)
details: Tool-specific data (for tool-call) or response data (for tool-response)
timestamp: ISO 8601 timestamp of the request

Details for tool-call event type (varies by tool):

Tool	Details Fields
`launch-process`	`cwd`, `command`
`view`	`path`
`str-replace-editor`	`path`, `command`
`save-file`	`path`
`remove-files`	`file_paths`
`web-fetch`	`url`

Details for tool-response event type:

Copy

Ask AI

{
  "text": "Tool output text",
  "isError": false
}

Expected response:

Copy

Ask AI

{
  "allow": true,
  "output": "Optional message to include in agent response"
}

Script Validation

Use local scripts for complex validation logic:

Copy

Ask AI

{
  "toolPermissions": [
    { "toolName": "launch-process", "permission": { "type": "script-policy", "script": "/path/to/validate-command.sh" } }
  ]
}

The script receives the same JSON payload as webhooks via stdin:

Copy

Ask AI

{
  "tool-name": "launch-process",
  "event-type": "tool-call",
  "details": {
    "cwd": "/path/to/workspace",
    "command": "npm install express"
  },
  "timestamp": "2025-01-01T02:41:40.580Z"
}

Script behavior:

Exit code 0: Allow the tool execution
Non-zero exit code: Deny the tool execution
stdout/stderr: Optional message included in the agent response

Example script:

Copy

Ask AI

#!/bin/bash
# Read JSON payload from stdin
payload=$(cat)

# Extract command using jq
command=$(echo "$payload" | jq -r '.details.command // empty')

# Deny dangerous commands
if [[ "$command" == *"rm -rf"* ]] || [[ "$command" == *"sudo"* ]]; then
  echo "Dangerous command blocked: $command"
  exit 1
fi

# Allow all other commands
exit 0

Best Practices

Be Explicit: Define clear rules for all tools you want to control
Test Configurations: Verify permissions work as expected before automation
Log Decisions: Monitor which tools are being allowed/denied for audit trails
Regular Reviews: Periodically review and update permission rules
Order Matters: Remember that rules are evaluated top-down, first match wins

Troubleshooting

Ask-User Mode in Automation:

Ask-user permissions automatically deny in non-interactive mode
Use explicit allow/deny rules for automation scenarios
Consider webhook or script policies for dynamic decisions

MCP Tools Not Recognized:

Ensure MCP server name follows {tool}_{server} pattern
Check for 64-character truncation on long names
Verify MCP server is properly configured and running

Security Considerations

Never commit sensitive webhook URLs to version control
Use .augment/settings.local.json for personal security overrides
Regularly audit tool usage in production environments
Implement defense in depth with multiple permission layers
Test permission changes in isolated environments first

Authentication - Secure access to Auggie
Custom Rules - Project-specific guidelines
MCP Integrations - External tool configuration
Automation - Using permissions in CI/CD

Getting Started

Models & Pricing

Configuration

Visual Studio Code

JetBrains IDEs

Auggie CLI

Intent by Augment

Vim and Neovim

Context Services

Augment Code Review

Slack

Analytics

Teams

Troubleshooting

​About Tool Permissions

​How Permissions Work

​Permission Flow

​Notes on Unmatched Tools

​Configuration Files

​Basic Configuration

​Creating Rules

​Basic Rule Structure

​Allow List Configuration

​Block List Configuration

​Mix and Match Configuration

​Available Tools

​Process Management

​File Operations

​External Services

​MCP Server Tools

​Advanced Rules

​Shell Command Filtering

​Event-Based Permissions

​Interactive Approval

​Keyboard Shortcuts

​Common Configurations

​Read-Only Mode

​Development Mode

​CI/CD Pipeline

​Custom Policies

​Webhook Validation

​Script Validation

​Best Practices

​Troubleshooting

​Security Considerations

​Related Features

About Tool Permissions

How Permissions Work

Permission Flow

Notes on Unmatched Tools

Configuration Files

Basic Configuration

Creating Rules

Basic Rule Structure

Allow List Configuration

Block List Configuration

Mix and Match Configuration

Available Tools

Process Management

File Operations

External Services

MCP Server Tools

Advanced Rules

Shell Command Filtering

Event-Based Permissions

Interactive Approval

Keyboard Shortcuts

Common Configurations

Read-Only Mode

Development Mode

CI/CD Pipeline

Custom Policies

Webhook Validation

Script Validation

Best Practices

Troubleshooting

Security Considerations

Related Features