bricks_update_page_schema

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

With no annotations, description discloses key behaviors: automatic addition of @context and output placement as <script> in page head. This adds value beyond a generic 'update' statement. However, does not mention permissions or reversibility.

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, no unnecessary words. Front-loaded with purpose, then details. Efficient and well-structured.

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 two-parameter tool with full schema coverage and no output schema, the description covers purpose, parameter flexibility, automatic behavior, and output format. Complete for its complexity.

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 coverage is 100%, so baseline is 3. Description adds semantic value by noting that the tool accepts a single schema object or an array, and explains automatic addition of @context and output location, which is not in the schema. Just above baseline.

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 the tool sets JSON-LD structured data (Schema.org) for a page, using specific verb 'Set' and resource 'page schema'. It distinguishes from siblings like bricks_get_page_schema (read) and bricks_update_page_seo (SEO meta).

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?

Description explains what the tool does but does not provide explicit guidance on when to use it versus alternatives (e.g., bricks_get_page_schema for retrieval, bricks_update_page for general updates). Context is implied but not explicit.

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