cyd_package_upload

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 covers atomicity, SHA-256 verification, default encoding, preservation of existing files unless replace is true, and the foreground-app failure condition. This is strong transparency for a mutation 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 four short sentences with the core operation front-loaded. It adds no redundant restatement of the schema, and every sentence contributes behavioral or usage information.

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?

Despite having no annotations and no output schema, the description covers the operation, preconditions, binary/text handling, and existing-file behavior. It does not describe return values or exact failure details, but those are not critical gaps for this upload action.

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%, so the description must compensate. It explains the target path via app_id, the file name placement, encoding choices with a concrete JPEG example, and replace semantics. Content is implied as the uploaded file data, though not explicitly named.

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 states a specific operation: atomically upload one file into /sd/apps/<app_id>/ after SHA-256 verification. This clearly distinguishes it from sibling tools such as cyd_app_deploy or cyd_app_delete and gives an exact target path.

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?

It gives concrete invocation conditions: text is the default, base64 must be used for binary assets like JPEGs, existing files are preserved unless replace is true, and the tool fails while a foreground app is running. It does not name alternative tools explicitly, but the conditions and target path make intended usage clear.

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