wp_insert_shortcode

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

There are no annotations, so the description must carry the full burden of behavioral disclosure. It states that content is inserted before or after an existing shortcode, but it does not mention side effects, failure behavior when the anchor is missing, the meaning of occurrence, or whether dry_run prevents writes.

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 a single sentence with no filler and the core action is front-loaded. It is appropriately concise for what it communicates.

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?

This is a write operation with no annotations and no output schema, yet the description only covers the basic insertion action. It lacks context about return values, error conditions, ambiguous anchors, and the effect of occurrence or attribute matching, so an agent is under-informed before invoking it.

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 high (88%), so the baseline is 3. The description adds little parameter-specific meaning beyond what the schema already provides, though it does implicitly map to new_content, anchor_tag, and position.

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 clearly names a specific action ('Insert'), a specific target ('existing shortcode'), and a scope ('in a page'). It is easy to tell apart from sibling tools like wp_replace_shortcode, but it does not explicitly call out that distinction.

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 gives no guidance on when to choose this tool over alternatives like wp_replace_shortcode or wp_elementor_update_shortcode_content. It also omits prerequisites, such as the requirement that the anchor shortcode already exists in the page.

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