tool-schema-design

Solid

Design and validate model-facing tool definitions with clear names, action-oriented descriptions, bounded JSON Schema parameters, explicit side effects, safe defaults, idempotency, errors, and realistic tests. Use when creating function-calling tools, MCP tools, agent actions, structured tool inputs, or when a model selects the wrong tool, invents arguments, or causes unsafe side effects.

AI & Automation 161 stars 32 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
74
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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: 1. A tool-boundary decision and overlap analysis. 2. A model-facing name and description with explicit use and non-use conditions. 3. A valid parameter schema with constraints, examples, and unknown-field policy. 4. Side-effect, confirmation, authorization, idempotency, timeout, and error contracts. 5. Positive, boundary, adversarial, and tool-selection tests. 6. Validation results and any provider-specific limitations. ## Workflow 1. Define one coherent user intent per tool. Split tools whose modes have different permissions, side effects, or required fields; avoid tiny tool sets with indistinguishable names. 2. Choose a stable verb-led name. Write the description to say what the tool does, when to call it, when not to call it, and what state it changes. 3...

Details

Author
seb1n
Repository
seb1n/awesome-ai-agent-skills
Created
6 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category