Api frameworks upload image create

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

Annotations already cover the write/non-idempotent/non-destructive safety profile. The description adds that the upload is for splash screen markdown and applies in draft mode, but says nothing about file format/size, overwrite behavior, permissions, or what the response contains.

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?

A single front-loaded sentence with no filler. It communicates purpose and context compactly.

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 write/upload tool with no output schema and a schema that only lists id, the description is too thin. It omits the image payload mechanism, validation constraints, and post-upload behavior, leaving the agent unable to call it confidently.

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?

Only one parameter, id, is defined and the schema has 0% description coverage. The description does not explain that id is the framework identifier, nor does it mention how the image itself is supplied—a critical omission given the tool uploads an image but the schema exposes no file field.

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 names a specific verb ('Upload'), resource ('image'), and target ('this framework'), plus the use case ('splash screen markdown in draft mode'). It does not explicitly name a sibling alternative, but the framework scope distinguishes it from requirement_nodes_upload_image_create and managed_documents_upload_image_create.

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 parenthetical states a clear scenario: splash screen markdown while in draft mode, which implies this should be used only on draft frameworks. It does not explain when not to use it or name alternatives such as serve_image or publish_draft.

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