get_zod_schema

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the behavioral disclosure burden. It discloses the return type ('Zod schema definition code as a string, or an error dictionary') and implies network/filesystem interaction through 'live OpenAPI URL' and 'project_dir.' It does not detail side effects or error conditions beyond an error dictionary, but this is reasonable for a code-generation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and well-structured with clear Args and Returns sections. The opening sentence states the core purpose, and every subsequent line adds useful detail without repetition or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter tool with no output schema, the description provides enough context: target forms, optional project directory, return type, and error outcome. It could mention prerequisites such as whether a local FastAPI app must be importable or whether a URL must be publicly accessible, but the current level is largely sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description fully compensates. It explains 'target' with three concrete example formats and clarifies that 'project_dir' is an optional path to the project root. Each parameter receives meaning beyond its raw type in the input schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Generate Zod validation schemas with inferred TypeScript types.' It then names the accepted source types: Pydantic model, FastAPI app, or live OpenAPI URL. This clearly differentiates it from siblings like get_openapi_schema and get_pydantic_schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly states what kinds of targets are accepted and gives concrete examples such as 'models.user:UserProfile' and 'main:app'. It does not explicitly say when to prefer this over get_typescript_definition or get_openapi_schema, but the supported targets and output format make the intended usage clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.