Tool Schema Migration Notice Spec
Produce a developer-facing email specification announcing breaking tool-calling schema updates.
Use this template when deprecating legacy tool definitions or altering JSON parameter signatures across client agent chains. It ensures client engineering teams migrate without runtime downtime.
Role: Enterprise Agent Platform Technical Account Lead
Context
- Client engineering account: {{client_account}}
- Deprecated tool signature: {{deprecated_tool_definition}}
- Updated tool schema specification: {{replacement_tool_schema}}
- Strict migration deadline: {{migration_window_date}}
- Impacted autonomous workflows: {{affected_workflow_chains}}
- Staging sandbox URL: {{sandbox_testing_endpoint}}
Task
Generate a developer-oriented client notification email specification outlining breaking tool schema changes, providing explicit JSON schema diffs, and delivering migration instructions to prevent agent execution failures.
Method
- Parse the structural breaking changes between {{deprecated_tool_definition}} and {{replacement_tool_schema}}.
- Identify specific operational failure risks across {{affected_workflow_chains}} if migration is missed.
- Establish the timeline of deprecation phases culminating on {{migration_window_date}}.
- Draft a direct, developer-ready email copy explaining the JSON schema update rationale.
- Include step-by-step validation instructions for {{sandbox_testing_endpoint}}.
- Formulate proactive mitigation steps to prevent agent hallucination on outdated schemas.
- Specify direct escalation channels for schema validation support.
Constraints
- MUST include before-and-after JSON schema snippet blocks in the specification.
- MUST NOT use vague deprecation dates; anchor everything to {{migration_window_date}}.
- Email draft body MUST stay between 250 and 350 words.
- Emphasize zero-downtime hot-swapping procedures.
- Language MUST be precise and targeted toward API developers.
Output format
Provide the specification in three numbered markdown sections:
- Technical Broadcast Header (Subject lines, target developer audience, urgency rating)
- Migration Specification Email (Context, schema diff, sandbox instructions)
- Testing Checklist & Failure Mode Reference (Verification queries, failure signatures)
Self-review
- Validate that {{deprecated_tool_definition}} and {{replacement_tool_schema}} are contrasted clearly.
- Check that the sandbox verification steps on {{sandbox_testing_endpoint}} are functional.
- Ensure all constraint limits on length and formatting are strictly satisfied.
Explicit role, a named task, and discrete steps the model can follow.
Background, inputs and variables the model needs before it starts.
Hard boundaries — what the model must and must not do.
A named, field-level shape for the response.
Ordered work items that force analysis before an answer.
Length and structure that travel across frontier models.
Signal density — instruction weight without padding.
Documented variables so the scaffold adapts to new inputs.
Quality bar, assumptions and behaviour when inputs are thin.
How much real usage the template has behind it.