配置权限
使用权限模式、hooks 和声明式允许/拒绝规则来控制您的代理如何使用工具。
Claude Agent SDK 提供权限控制来管理 Claude 如何使用工具。使用权限模式和规则来定义自动允许的内容,以及使用 canUseTool 回调 在运行时处理其他所有情况。
本页面涵盖权限模式和规则。要构建交互式批准流程,其中用户在运行时批准或拒绝工具请求,请参阅 处理批准和用户输入。
权限如何被评估
当 Claude 请求一个工具时,SDK 按以下顺序检查权限:
Hooks
首先运行 hooks。一个 hook 可以直接拒绝调用或将其传递下去。返回 allow 的 hook 不会跳过下面的拒绝和询问规则;无论 hook 结果如何,这些规则都会被评估。
拒绝规则
检查 deny 规则(来自 disallowed_tools 和 settings.json)。如果拒绝规则匹配,工具被阻止,即使在 bypassPermissions 模式下也是如此。裸名称拒绝规则(如 Bash)在此评估开始之前将工具从 Claude 的上下文中移除,因此只有作用域规则(如 Bash(rm *))在此步骤中被检查。
询问规则
检查来自 settings.json 的 ask 规则。如果询问规则匹配,调用会传递到您的 canUseTool 回调 以获得确认,即使在 bypassPermissions 模式下也是如此。在 dontAsk 模式下,匹配的询问规则会被拒绝,因为该模式从不提示。
权限模式
应用活跃的 权限模式。bypassPermissions 批准到达此步骤的所有内容。acceptEdits 批准文件操作。plan 将文件编辑和 shell 写入工具路由到您的 canUseTool 回调,无论允许规则如何,因此在规划时写入操作无法自动批准。其他模式会继续进行。
允许规则
检查 allow 规则(来自 allowed_tools 和 settings.json)。如果规则匹配,工具被批准。
canUseTool 回调
如果上述任何步骤都未解决,调用您的 canUseTool 回调 以获得决定。在 dontAsk 模式下,此步骤被跳过,工具被拒绝。
本页面重点关注 允许和拒绝规则 以及 权限模式。对于其他步骤:
- Hooks: 运行自定义代码以允许、拒绝或修改工具请求。请参阅 使用 hooks 控制执行。
- canUseTool 回调: 在运行时提示用户批准。请参阅 处理批准和用户输入。
允许和拒绝规则
allowed_tools 和 disallowed_tools(TypeScript:allowedTools / disallowedTools)向上面评估流程中的允许和拒绝规则列表添加条目。允许规则仅影响批准:未在 allowed_tools 中列出的工具仍然可供 Claude 使用,并继续进行权限模式。拒绝规则的行为取决于它们是命名工具还是在工具内范围化模式。
| 选项 | 效果 |
|---|---|
allowed_tools=["Read", "Grep"] |
Read 和 Grep 被自动批准。此处未列出的工具仍然存在并继续进行权限模式和 canUseTool。 |
disallowed_tools=["Bash"] |
Bash 工具定义从请求中移除。Claude 看不到该工具,无法尝试它。 |
disallowed_tools=["Bash(rm *)"] |
Bash 保持可用。与 rm * 匹配的调用在每个权限模式中都被拒绝,包括 bypassPermissions。其他 Bash 调用继续进行权限模式。 |
disallowed_tools=["*"] |
每个工具定义都从请求中移除。工具名称通配符在拒绝规则中受支持:"*" 匹配每个工具,"mcp__*" 匹配所有服务器中的每个 MCP 工具。 |
允许规则仅在字面 mcp__<server>__ 前缀之后接受工具名称通配符。服务器段必须无通配符,以便规则命名您配置的特定服务器:mcp__puppeteer__* 匹配来自 puppeteer 服务器的每个工具,mcp__github__get_* 匹配其 get_ 工具。未锚定的条目如 allowed_tools=["*"] 或 allowed_tools=["mcp__*"] 被忽略并显示启动警告,不会自动批准任何内容。
对于锁定的代理,将 allowedTools 与 permissionMode: "dontAsk" 配对。列出的工具被批准;其他任何内容都被直接拒绝,而不是提示:
const options = {
allowedTools: ["Read", "Glob", "Grep"],
permissionMode: "dontAsk"
};
allowed_tools 不约束 bypassPermissions。 allowed_tools 仅预批准您列出的工具。未列出的工具不与任何允许规则匹配,并继续进行权限模式,其中 bypassPermissions 批准它们。设置 allowed_tools=["Read"] 与 permission_mode="bypassPermissions" 一起仍然批准每个工具,包括 Bash、Write 和 Edit。如果您需要 bypassPermissions 但想要阻止特定工具,请使用 disallowed_tools。
您也可以在 .claude/settings.json 中声明式地配置允许、拒绝和询问规则。当启用 project 设置源时,这些规则被读取,默认 query() 选项就是这样。如果您显式设置 setting_sources(TypeScript:settingSources),请包含 "project" 以使其应用。请参阅 权限设置 了解规则语法。
权限模式
权限模式提供对 Claude 如何使用工具的全局控制。您可以在调用 query() 时设置权限模式,或在流式会话期间动态更改它。
可用模式
SDK 支持这些权限模式:
| 模式 | 描述 | 工具行为 |
|---|---|---|
default |
标准权限行为 | 无自动批准;不匹配的工具触发您的 canUseTool 回调 |
dontAsk |
拒绝而不是提示 | 任何未被 allowed_tools 或规则预批准的内容都被拒绝;canUseTool 永远不会被调用 |
acceptEdits |
自动接受文件编辑 | 文件编辑和 文件系统操作(mkdir、rm、mv 等)被自动批准 |
bypassPermissions |
绕过权限检查 | 工具运行而无需权限提示,除非显式 ask 规则 匹配(谨慎使用) |
plan |
规划模式 | Claude 在不编辑源文件的情况下探索和规划;文件编辑永远不会自动批准,并通过您的 canUseTool 回调提示 |
auto(仅 TypeScript) |
模型分类批准 | 模型分类器批准或拒绝每个工具调用。请参阅 Auto 模式 了解可用性 |
子代理继承: 当父代理使用 bypassPermissions、acceptEdits 或 auto 时,所有子代理继承该模式,并且不能按子代理覆盖。子代理可能有不同的系统提示和行为约束较少,比您的主代理,所以继承 bypassPermissions 授予它们完整的、自主的系统访问权限。显式 ask 规则 仍然会强制提示。
设置权限模式
您可以在启动查询时设置权限模式一次,或在会话活跃时动态更改它。
在创建查询时传递 permission_mode(Python)或 permissionMode(TypeScript)。此模式应用于整个会话,除非动态更改。
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions
async def main():
async for message in query(
prompt="Help me refactor this code",
options=ClaudeAgentOptions(
permission_mode="default", # 在此处设置模式
),
):
if hasattr(message, "result"):
print(message.result)
asyncio.run(main())
import { query } from "@anthropic-ai/claude-agent-sdk";
async function main() {
for await (const message of query({
prompt: "Help me refactor this code",
options: {
permissionMode: "default" // 在此处设置模式
}
})) {
if ("result" in message) {
console.log(message.result);
}
}
}
main();
调用 set_permission_mode()(Python)或 setPermissionMode()(TypeScript)以在会话中期更改模式。新模式立即对所有后续工具请求生效。这让您可以从限制性开始,随着信任建立而放松权限,例如在审查 Claude 的初始方法后切换到 acceptEdits。
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
async def main():
async with ClaudeSDKClient(
options=ClaudeAgentOptions(
permission_mode="default", # 以默认模式开始
)
) as client:
await client.query("Help me refactor this code")
# 在会话中期动态更改模式
await client.set_permission_mode("acceptEdits")
# 使用新权限模式处理消息
async for message in client.receive_response():
if hasattr(message, "result"):
print(message.result)
asyncio.run(main())
import { query } from "@anthropic-ai/claude-agent-sdk";
async function main() {
const q = query({
prompt: "Help me refactor this code",
options: {
permissionMode: "default" // 以默认模式开始
}
});
// 在会话中期动态更改模式
await q.setPermissionMode("acceptEdits");
// 使用新权限模式处理消息
for await (const message of q) {
if ("result" in message) {
console.log(message.result);
}
}
}
main();
模式详情
接受编辑模式(`acceptEdits`)
自动批准文件操作,以便 Claude 可以编辑代码而无需提示。其他工具(如不是文件系统操作的 Bash 命令)仍然需要正常权限。
自动批准的操作:
- 文件编辑(Edit、Write 工具)
- 文件系统命令:
mkdir、touch、rm、rmdir、mv、cp、sed
两者都仅适用于工作目录或 additionalDirectories 内的路径。该范围外的路径和对受保护路径的写入仍然会提示。
使用时机: 您信任 Claude 的编辑并希望更快的迭代,例如在原型设计期间或在隔离目录中工作时。
不询问模式(`dontAsk`)
将任何权限提示转换为拒绝。由 allowed_tools、settings.json 允许规则或作为 hook 运行的工具正常运行。其他所有内容都被拒绝,无需调用 canUseTool。
使用时机: 您想要为无头代理提供固定的、明确的工具表面,并且更喜欢硬拒绝而不是默默依赖 canUseTool 不存在。
绕过权限模式(`bypassPermissions`)
自动批准所有工具使用而无需提示。Hooks 仍然执行,如果需要可以阻止操作。
谨慎使用。Claude 在此模式下具有完整的系统访问权限。仅在您信任所有可能操作的受控环境中使用。
allowed_tools 不约束此模式。每个工具都被批准,而不仅仅是您列出的工具。拒绝规则(disallowed_tools)、显式 ask 规则和 hooks 在模式检查之前被评估,仍然可以阻止工具。
规划模式(`plan`)
Claude 探索代码库并生成计划而不编辑您的源文件。只读工具在默认模式下运行。文件编辑在规划模式下永远不会自动批准,即使允许规则匹配。它们通过您的 canUseTool 回调提示。Claude 可能使用 AskUserQuestion 在最终确定计划之前澄清需求。请参阅 处理批准和用户输入 以处理这些提示。
使用时机: 您想要 Claude 提议更改而不执行它们,例如在代码审查期间或当您需要在进行更改之前批准更改时。
相关资源
对于权限评估流程中的其他步骤: