pi-permission-system
v0.1.8
Published
Permission enforcement extension for the Pi coding agent.
Maintainers
Readme
🔐 pi-permission-system
Permission enforcement extension for the Pi coding agent that provides centralized, deterministic permission gates for tool, bash, MCP, skill, and special operations.

Features
- Tool Filtering — Hides disallowed tools from the agent before it starts (reduces "try another tool" behavior)
- System Prompt Sanitization — Removes denied tool entries from the
Available tools:system prompt section so the agent only sees tools it can actually call - Runtime Enforcement — Blocks/asks/allows at tool call time with UI confirmation dialogs
- Bash Command Control — Wildcard pattern matching for granular bash command permissions
- MCP Access Control — Server and tool-level permissions for MCP operations
- Skill Protection — Controls which skills can be loaded or read from disk
- Per-Agent Overrides — Agent-specific permission policies via YAML frontmatter
- Subagent Permission Forwarding — Forwards
askconfirmations from non-UI subagents back to the main interactive session - JSON Schema Validation — Full schema for editor autocomplete and config validation
Installation
Place this folder in one of the following locations:
| Scope | Path |
|---------|-----------------------------------------------|
| Global | ~/.pi/agent/extensions/pi-permission-system |
| Project | .pi/extensions/pi-permission-system |
Pi auto-discovers extensions in these paths.
Usage
Quick Start
- Create the global policy file at
~/.pi/agent/pi-permissions.jsonc:
{
"defaultPolicy": {
"tools": "ask",
"bash": "ask",
"mcp": "ask",
"skills": "ask",
"special": "ask"
},
"tools": {
"read": "allow",
"write": "deny"
}
}- Start Pi — the extension automatically loads and enforces your policy.
Permission States
All permissions use one of three states:
| State | Behavior |
|---------|---------------------------------------------|
| allow | Permits the action silently |
| deny | Blocks the action with an error message |
| ask | Prompts the user for confirmation via UI |
Pi Integration Hooks
The extension integrates via Pi's lifecycle hooks:
| Hook | Behavior |
|----------------------|-------------------------------------------------------------------------------------------|
| before_agent_start | Filters active tools, removes denied tool entries from the system prompt, and hides denied skills |
| tool_call | Enforces permissions for every tool invocation |
| input | Intercepts /skill:<name> requests and enforces skill policy |
Additional behaviors:
- Unknown/unregistered tools are blocked before permission checks (prevents bypass attempts)
- The
Available tools:system prompt section is rewritten to match the filtered active tool set - The
taskdelegation tool is restricted to theorchestratoragent only - When a subagent hits an
askpermission without direct UI access, the request can be forwarded to the main interactive session for confirmation - When a subagent triggers an
askpermission without UI access, the request can be forwarded to the main session and answered there
Configuration
Global Policy File
Location: ~/.pi/agent/pi-permissions.jsonc
The policy file is a JSON object with these sections:
| Section | Description |
|-----------------|------------------------------------------|
| defaultPolicy | Fallback permissions per category |
| tools | Built-in tool permissions |
| bash | Command pattern permissions |
| mcp | MCP server/tool permissions |
| skills | Skill name pattern permissions |
| special | Reserved permission checks |
Note: Trailing commas are not supported. If parsing fails, the extension falls back to
askfor all categories.
Per-Agent Overrides
Override global permissions for specific agents via YAML frontmatter in ~/.pi/agent/agents/<agent>.md:
---
name: my-agent
permission:
tools:
read: allow
write: deny
mcp: allow
bash:
git status: allow
git *: ask
mcp:
chrome_devtools_*: deny
exa_*: allow
skills:
"*": ask
---Precedence: Agent frontmatter overrides global config (shallow-merged per section).
MCP behavior: permission.tools.mcp is the coarse entry/fallback permission for the built-in mcp tool. More specific permission.mcp target rules override that fallback when they match.
Limitations: The frontmatter parser is intentionally minimal. Use only key: value scalars and nested maps. Avoid arrays, multi-line scalars, and YAML anchors.
Policy Reference
defaultPolicy
Sets fallback permissions when no specific rule matches:
{
"defaultPolicy": {
"tools": "ask",
"bash": "ask",
"mcp": "ask",
"skills": "ask",
"special": "ask"
}
}tools
Controls built-in tools by exact name (no wildcards):
| Tool | Description |
|---------|--------------------------------|
| bash | Shell command execution |
| read | File reading |
| write | File creation/overwriting |
| edit | Surgical file edits |
| grep | Pattern searching |
| find | File discovery |
| ls | Directory listing |
| mcp | MCP proxy tool entry/fallback |
{
"tools": {
"read": "allow",
"write": "deny",
"edit": "deny",
"mcp": "allow"
}
}Note: Setting
tools.bashaffects the default for bash commands, butbashpatterns can provide command-level overrides.Note: Setting
tools.mcpcontrols coarse access to the built-inmcptool. Specificmcprules still override it when a target pattern matches.
bash
Command patterns use * wildcards and match against the full command string. Patterns are sorted by specificity:
- Fewer wildcards wins
- Longer literal text wins
- Longer overall pattern wins
{
"bash": {
"git status": "allow",
"git diff": "allow",
"git *": "ask",
"rm -rf *": "deny"
}
}mcp
MCP permissions match against derived targets from tool input. These rules are more specific than tools.mcp and override that fallback when a pattern matches:
| Target Type | Examples |
|-------------------|---------------------------------------------|
| Baseline ops | mcp_status, mcp_list, mcp_search, mcp_describe, mcp_connect |
| Server name | myServer |
| Server/tool combo | myServer:search, myServer_search |
| Generic | mcp_call |
{
"mcp": {
"mcp_status": "allow",
"mcp_list": "allow",
"myServer:*": "ask",
"dangerousServer": "deny"
}
}Note: Baseline discovery targets may auto-allow when you permit any MCP rule.
MCP Tool Fallback via tools.mcp
The mcp built-in tool can use tools.mcp as an entry permission point. This provides a fallback when no specific MCP pattern matches:
{
"tools": {
"mcp": "allow"
}
}This is useful for per-agent configurations where you want to grant MCP access broadly:
# In ~/.pi/agent/agents/researcher.md
---
name: researcher
permission:
tools:
mcp: allow
---The permission resolution order for MCP operations:
- Specific
mcppatterns (e.g.,myServer:toolName,myServer_*) tools.mcpfallback (if set)defaultPolicy.mcp
skills
Skill name patterns use * wildcards:
{
"skills": {
"*": "ask",
"dangerous-*": "deny"
}
}special
Reserved permission checks:
| Key | Description |
|----------------------|------------------------------------------|
| doom_loop | Controls doom loop detection behavior |
| external_directory | Controls access outside working directory |
| tool_call_limit | (schema only, not enforced yet) |
{
"special": {
"doom_loop": "deny",
"external_directory": "ask"
}
}Common Recipes
Read-Only Mode
{
"defaultPolicy": { "tools": "ask", "bash": "ask", "mcp": "ask", "skills": "ask", "special": "ask" },
"tools": {
"read": "allow",
"grep": "allow",
"find": "allow",
"ls": "allow",
"write": "deny",
"edit": "deny"
}
}Restricted Bash Surface
{
"defaultPolicy": { "tools": "ask", "bash": "deny", "mcp": "ask", "skills": "ask", "special": "ask" },
"bash": {
"git status": "allow",
"git diff": "allow",
"git log *": "allow",
"git *": "ask"
}
}MCP Discovery Only
{
"defaultPolicy": { "tools": "ask", "bash": "ask", "mcp": "ask", "skills": "ask", "special": "ask" },
"mcp": {
"mcp_status": "allow",
"mcp_list": "allow",
"mcp_search": "allow",
"mcp_describe": "allow",
"*": "ask"
}
}Per-Agent Lockdown
In ~/.pi/agent/agents/reviewer.md:
---
permission:
tools:
write: deny
edit: deny
bash:
"*": deny
---Technical Details
Subagent Permission Forwarding
When a delegated or routed subagent runs without direct UI access, ask permissions can still be enforced by forwarding the confirmation request through Pi session directories. The main interactive session polls for forwarded requests, shows the confirmation prompt, writes the response, and the subagent resumes once that decision is available.
This keeps ask policies usable even when the original permission check happens inside a non-UI execution context.
Architecture
index.ts → Root Pi entrypoint shim
src/
├── index.ts → Extension bootstrap, permission checks, and subagent forwarding
├── permission-manager.ts → Policy loading, merging, and resolution with caching
├── bash-filter.ts → Bash command wildcard pattern matching
├── wildcard-matcher.ts → Shared wildcard pattern compilation and matching
├── common.ts → Shared utilities (YAML parsing, type guards, etc.)
├── tool-registry.ts → Registered tool name resolution
├── types.ts → TypeScript type definitions
└── test.ts → Test runner
schemas/
└── permissions.schema.json → JSON Schema for config validation
config/
└── config.example.json → Starter configuration templateModule Organization
The extension uses a modular architecture with shared utilities:
| Module | Purpose |
|--------|---------|
| common.ts | Shared utilities: toRecord(), getNonEmptyString(), isPermissionState(), parseSimpleYamlMap(), extractFrontmatter() |
| wildcard-matcher.ts | Compile-once wildcard patterns with specificity sorting: compileWildcardPatterns(), findCompiledWildcardMatch() |
| permission-manager.ts | Policy resolution with file stamp caching for performance |
| bash-filter.ts | Uses shared wildcard matcher for bash command patterns |
Performance Optimizations
- File stamp caching: Configurations are cached with file modification timestamps to avoid redundant reads
- Pre-compiled patterns: Wildcard patterns are compiled to regex once and reused across permission checks
- Resolved permissions caching: Merged agent+global permissions are cached per-agent with invalidation on file changes
Threat Model
Goal: Enforce policy at the host level, not the model level.
What this stops:
- Agent calling tools it shouldn't use (e.g.,
write, dangerousbash) - Tool switching attempts (calling non-existent tool names)
- Accidental escalation via skill loading
Limitations:
- If a dangerous action is possible via an allowed tool, policy must explicitly restrict it
- This is a permission decision layer, not a sandbox
Schema Validation
Validate your config against the included schema:
npx --yes ajv-cli@5 validate \
-s ./schemas/permissions.schema.json \
-d ./pi-permissions.valid.jsonEditor tip: Add "$schema": "./schemas/permissions.schema.json" to your config for autocomplete support.
Troubleshooting
| Problem | Cause | Solution |
|---------|-------|----------|
| Config not applied (everything asks) | File not found or parse error | Verify file at ~/.pi/agent/pi-permissions.jsonc; check for trailing commas |
| Per-agent override not applied | Frontmatter parsing issue | Ensure --- delimiters at file top; keep YAML simple; restart session |
| Tool blocked as unregistered | Unknown tool name | Use built-in mcp tool for server tools: { "tool": "server:tool" } |
| /skill:<name> blocked | Missing context or deny policy | Requires active agent context; ask behaves as block in headless mode |
Development
npm run build # Compile TypeScript
npm run lint # Run linter (uses build)
npm run test # Run tests
npm run check # Run lint + test