Skip to main content
Glama

generate_typescript_dto

Generate TypeScript DTO type declarations from OpenAPI component schemas, including referenced nested types, for API contract integration.

Instructions

Generate TypeScript DTO type declarations from OpenAPI components schema. Includes referenced nested DTO types.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
backendIdYesRequired backend id from list_backends.
schemaNameYesComponent schema name under #/components/schemas.
specUrlNoOptional docs URL override for this call.
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions generating DTOs and including nested types, but fails to describe critical behaviors such as error handling, output format, or any constraints like rate limits or authentication needs. This leaves significant gaps in understanding how the tool operates beyond its basic purpose.

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

Conciseness5/5

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

The description is a single, well-structured sentence that efficiently conveys the tool's purpose and key feature (including nested DTOs). It is front-loaded with the main action and avoids unnecessary details, making it easy to understand quickly without wasted words.

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

Completeness2/5

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

Given the tool's complexity (generating code from OpenAPI schemas) and the lack of annotations and output schema, the description is insufficient. It does not explain what the output looks like, how errors are handled, or any dependencies on other tools like 'list_backends'. This leaves the agent with incomplete information for effective tool invocation.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description does not add any meaning beyond what the schema provides, such as explaining relationships between parameters or usage nuances. With high schema coverage, the baseline score of 3 is appropriate as the description does not compensate but also does not detract.

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

Purpose5/5

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

The description clearly states the specific action ('Generate TypeScript DTO type declarations') and the source ('from OpenAPI components schema'), with additional detail about including referenced nested DTO types. It distinguishes itself from sibling tools like 'list_backends' or 'load_openapi_spec' by focusing on code generation rather than listing or loading operations.

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

Usage Guidelines3/5

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

The description implies usage when TypeScript DTOs are needed from OpenAPI schemas, but it does not explicitly state when to use this tool versus alternatives like 'get_endpoint_contract' or 'propose_new_endpoint'. No guidance is provided on prerequisites or exclusions, leaving usage context inferred rather than clearly defined.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/heecheon92/specbridge-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server