bsdd_get_class

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

There are no annotations, so the description must convey behavioral traits. It mentions that the result includes properties, relations, and child classes, but does not disclose defaults (e.g., includeChildren and includeRelations default to false), potential performance implications, or any read-only guarantees. This is minimal transparency.

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 one substantive sentence with a short second sentence. It is front-loaded with the verb and key details. The second sentence, 'Essential for BIM enrichment,' is somewhat promotional and adds little informational value, slightly reducing the score.

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?

With no output schema, the description partially addresses return content by listing what is included (properties, relations, child classes). However, it does not describe the response structure, pagination, or error cases. It is adequate for a read tool but not fully complete.

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 the schema already documents all parameters. The description adds little beyond the schema, only reinforcing that properties, relations, and child classes are covered by the include flags. This is baseline for full schema coverage.

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's function: 'Get full details of a bSDD class' with concrete examples (IfcWall, IfcDoor). It also lists the included content (properties, relations, child classes), which differentiates it from more focused sibling tools like bsdd_get_class_properties and bsdd_get_class_relations.

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?

No explicit guidance is provided on when to use this tool versus alternatives. The phrase 'Essential for BIM enrichment' is vague and does not clarify when to choose this over siblings such as bsdd_get_class_properties or bsdd_search_classes.

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