Publish artifact

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

Describes core action, output, and a key constraint (local path vs remote content). However, with no annotations, it misses details on permissions, error states, or side effects like overwrite behavior beyond revisions.

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?

Three sentences, each adding value: purpose, revision guidance, local/remote distinction. No redundant or filler words, front-loaded with the primary action.

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 complexity (7 params, nested objects, no output schema), the description omits return format details, full parameter interactions, and tool environment. Significant gaps remain for an agent to use correctly without external knowledge.

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?

Adds meaning for slug and updateExisting (revision mechanism) and source types (path/folder vs content). But 7 parameters exist, schema coverage is only 29%, and the description does not explain tags, title, renderer, or description parameters.

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?

Description clearly states tool snapshots files, folders, or inline content into the artifact shelf and returns a stable browser preview URL. It distinguishes from siblings (delete, list) and mentions revision behavior with updateExisting.

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?

Provides explicit guidance on using the same slug with updateExisting:true for pushing revisions, and clarifies local vs remote source handling. While it does not explicitly contrast with siblings, the context makes the use case clear.

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