Agent Tool Specification and Parameter Documentation Brief

Role: Staff Developer Documentation Architect specializing in autonomous agent tool-calling schemas and function execution protocols.

Context

• Target Orchestration Framework: {{agent_framework}}
• Target API Endpoints: {{target_api_endpoints}}
• Parameter Boundaries & Typing: {{parameter_constraints}}
• Error & Retry Semantics: {{failure_semantics}}
• Developer Audience: {{target_audience}}
• Execution Environment: {{environment_context}}

Task

Draft an exhaustive tool-calling specification brief that translates backend API contracts into unambiguous, zero-hallucination function definitions, developer implementation guides, and runtime injection docstrings.

Method

1. Analyze {{target_api_endpoints}} to map all required inputs, optional flags, and return object shapes.
2. Translate raw backend schemas into agent-interpretable JSON schemas adhering to {{agent_framework}} conventions.
3. Draft natural-language semantic descriptions for every parameter, explicitly referencing boundaries from {{parameter_constraints}}.
4. Define deterministic parameter validation rules to prevent out-of-distribution hallucinations during autonomous execution.
5. Document idempotent execution rules, rate limits, and authentication wrappers within {{environment_context}}.
6. Formulate precise error-handling behaviors using {{failure_semantics}} for standard runtime exceptions.
7. Generate three real-world invocation scenarios, contrasting valid parameter bundles with invalid anti-patterns.
8. Structure the final copy tailored specifically to the workflow needs of {{target_audience}}.

Constraints

• MUST write exact JSON Schema definitions with type annotations for every parameter.
• MUST NOT leave parameter descriptions generic or omit boundary edge-case handling.
• MUST define fallback actions for non-recoverable error codes identified in {{failure_semantics}}.
• Descriptions must be optimized for token efficiency and high LLM parsing accuracy.
• Word count for the final brief must stay between 800 and 1,200 words.

Output format

Return a Markdown technical brief containing:

1. Executive Summary & Tool Registry Overview
2. Function Signatures & JSON Schema Definitions
3. Parameter Dictionaries (Name, Type, Required, Description, Boundary Rules)
4. Error Handling Matrix (Status Code, Agent Action, User Notification)
5. Synthetic Invocation Examples (Valid Call, Invalid Call, Recovery Flow)

Self-review

• Are all parameter types explicitly declared and constrained against hallucinations?
• Does the docstring text adhere to standard token-conscious formatting for {{agent_framework}}?
• Are failure paths deterministically linked to recovery strategies?