Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Require permission for every tool call or for one operation found risky at runtime.
| Approval API | Use it when |
|---|---|
@require_human_approval | Every invocation is sensitive |
request_human_approval(...) | Evaluation finds one sensitive operation |
from harnest.approval import require_human_approval
from harnest.tool import tool
@tool
@require_human_approval(message="Approve deleting {customer_id}?")
def delete_customer(customer_id: str):
return database.delete_customer(customer_id)
from harnest.approval import request_human_approval
from harnest.tool import tool
@tool
async def execute_typescript(source: str) -> str:
"""Evaluate policy before executing TypeScript."""
risk = evaluate_typescript(source)
if not risk.requires_approval:
return await execute(source)
async with request_human_approval(
action="typescript.execute",
message="Execute TypeScript with network access?",
arguments={
"sourceHash": risk.source_hash,
"capabilities": sorted(risk.capabilities),
},
):
return await execute(source)
| Stage | Behavior |
|---|---|
| Evaluate | Inspect code, network access, database intent, or another risk signal |
| Request | Enter the block; Harnest suspends the task and returns requires_action |
| Decide | Approve or deny through POST /approvals/{approvalId} |
| Resume | Continue at the block without replaying earlier work |
| Bound value | Purpose |
|---|---|
| Authenticated user | Prevent another user from consuming it |
| Session | Keep the decision inside the conversation |
| Invocation | Resume only the suspended run |
action | Identify the protected operation |
| Canonical argument hash | Detect changed operation inputs |
| Input | Rule | Example |
|---|---|---|
action | Stable and non-sensitive | typescript.execute |
arguments | Serializable values identifying the operation | Source hash and capabilities |
message | Public text shown to the approver | Execute TypeScript with network access? |
| Outcome | Recorded status |
|---|---|
| Block exits normally | Executed |
| Operation raises | Failed |
| Task is cancelled | Failed |
| Later block is reached | New approval request |
| Behavior | Result |
|---|---|
| One-time consumption | A decision cannot authorize a second execution |
| Identity and argument validation | Changed context cannot reuse approval |
| Expiration and denial | Protected code does not run |
| Transport support | JSON, SSE, and WebSocket |
| Audit telemetry | Privacy-safe outcomes |
| Framework support | Managed ADK and LangGraph |