Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Run typed, validated capabilities inside the agent server.
@tool when the capability should execute inside the agent server.
from harnest.models.orders import OrderStatus
from harnest.tool import tool
@tool(output_schema=OrderStatus)
def lookup_order(order_id: str):
"""Load one order status."""
return {"order_id": order_id, "status": "processing"}
| Property | Rule |
|---|---|
| File | tools/lookup_order.py |
| Export | lookup_order |
| Description | Docstring or @tool(description="...") |
| Output validation | Pydantic return annotation or output_schema |
| Unit testing | Call the decorated function directly |
| Need | Use |
|---|---|
| Application resource | context.resource("name") |
| Current user | context.user_id |
| Current session | context.session_id |
| Downstream credential | await context.credentials.resolve(...) |
from harnest.approval import require_human_approval
@tool
@require_human_approval(message="Approve deleting {customer_id}?")
def delete_customer(customer_id: str):
return database.delete_customer(customer_id)
request_human_approval(...).