Documentation
README
Tool Schema Design
Make the safe, intended call easier for a model to choose than an ambiguous or destructive alternative.
Use when
- Add or revise a function-calling, MCP, plugin, or internal agent tool.
- Split an overloaded API operation into model-usable actions.
- Reduce wrong-tool selection, malformed arguments, or fabricated fields.
- Document authorization, confirmation, idempotency, and error behavior.
Inputs
Collect supported user intents, backend operation semantics, required credentials, actor and tenant scope, side effects, reversibility, latency, rate limits, failure modes, and provider-specific schema constraints. Obtain representative valid and invalid requests.
Output contract
Produce:
This is the opening of the README. Read the full README on GitHub.