roam_markdown_cheatsheet

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

No annotations are provided, so the description must convey behavioral traits. The description implies a read-only, non-destructive operation by stating it provides reference information. However, it does not explicitly confirm safety, permissions, or rate limits. The 'API efficiency tips' mention adds some behavioral context, but overall transparency is adequate but not thorough.

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 relatively concise given the extensive list of topics covered. It is front-loaded with the main purpose, followed by a bullet-like list, and ends with an important usage note. Every sentence adds value, though the list could be slightly more 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?

The description fully explains what the tool provides and includes a usage directive. Given no output schema, the description does not specify return format, but the nature of a cheatsheet makes this acceptable. The tool's role among siblings is clear, and the description is complete enough for effective use.

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 has 100% coverage for its two parameters (graph and write_key), with clear descriptions. The description does not add any extra meaning beyond the schema. Baseline of 3 is appropriate since schema already handles parameter documentation.

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 'provides the comprehensive Roam syntax reference' with a specific verb and resource. It covers a wide range of topics, distinguishing it from the sibling tools which are all action-oriented (create, fetch, search, etc.) rather than reference.

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 includes an explicit usage guideline: 'Always load this cheatsheet before creating or updating Roam content.' This gives clear context for when to use the tool. It does not mention when not to use or alternatives, but since this is the only reference tool among siblings, exclusion is not necessary.

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