bricks_social_preview

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

Without annotations, the description partially conveys behavioral traits by indicating a read-only check operation. However, it does not explicitly state that no modifications occur, nor does it disclose any side effects, rate limits, or authentication requirements.

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 brief with two clear sentences, front-loading the purpose. It is efficient and avoids unnecessary verbiage, though a more structured format could improve scanability.

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 simple tool with one parameter, the description covers the main function and validation details. However, it omits information about the output format or any error conditions, which would be expected given no output schema.

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?

The input schema covers the single parameter page_id with a description. The description adds overall context about validation but does not enhance the meaning of page_id beyond what the schema provides. Since schema coverage is 100%, baseline of 3 is appropriate.

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 states the tool checks social media sharing preview for a page, specifying validation of OG image dimensions and character lengths. It distinguishes itself from sibling tools like bricks_get_page and bricks_seo_analyze by focusing on preview data rather than general page retrieval or SEO analysis.

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 lacks explicit guidance on when to use this tool versus alternatives. It does not mention prerequisites, when-not-to-use scenarios, or comparisons to related tools such as bricks_seo_analyze or bricks_get_page_seo, leaving the agent to infer usage context.

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