sw_get_properties

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

The annotations already provide strong safety guarantees (readOnlyHint: true, destructiveHint: false). The description adds useful operational context by confirming that the properties are read within the scope of a specific document and configuration.

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 maximally concise, consisting of a single, high-impact sentence that immediately tells the user the tool's function.

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?

Despite having two contextual parameters (document and configuration), the description remains extremely vague. Without an output schema, the agent is left to infer what kind of 'properties' are returned or if there are any limitations on the data scope.

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?

With only 50% schema description coverage, the description adds marginal value by clarifying that the 'doc' parameter can be a path or title and defaults to the active document. However, since the coverage is low, the description cannot fully compensate for the missing documentation on the other 50% of the schema.

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 states the action ('Read custom properties'), but it lacks differentiation from the extensive list of similar sibling tools (e.g., sw_set_properties, sw_mass_properties). It is clear what it does, but not distinctly how it fits into the overall tool ecosystem.

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 definition provides no guidance on when to use this tool versus other available tools. There is no mention of prerequisites, limitations, or how to distinguish 'custom' properties from other available property operations.

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