execute_joplin_readonly_script

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

The description discloses all behavioral traits: read-only mode, blocking modifications, top-level await, return of results, and special handling of pre-formatted output methods. No annotations are provided, so the description fully carries the burden, and it does so thoroughly.

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 lengthy but well-organized into sections (notebooks, notes, search, rules). It is front-loaded with the core purpose. While every sentence is useful, the overall length could be slightly reduced without losing clarity.

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?

Given the tool's complexity, no output schema, and single parameter, the description is exceptionally complete. It covers all available methods, search syntax, and behavioral rules, leaving no ambiguity about how to use the tool.

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?

Although the schema covers the single parameter 'script' with a basic description, the tool description adds significant context by specifying the expected code structure (e.g., using joplin methods, search syntax) and providing detailed API references.

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 executes JavaScript with the 'joplin' object in read-only mode. It lists available methods for notebooks and notes, and explicitly distinguishes from the sibling by emphasizing read-only operations.

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 provides comprehensive usage guidelines, including how to call methods (e.g., joplin.notebooks.X()), search syntax with examples, and rules for pre-formatted output (respond only 'Done'). It implies when to use this tool versus the sibling by specifying read-only mode.

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