directus_get_openapi_spec

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

With no annotations provided, the description carries the full burden of disclosure but offers no behavioral details. It does not indicate whether this is a read-only operation (implied but not stated), whether the spec is cached, its typical size, or potential rate limiting concerns when fetching large specifications.

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 extremely brief (effectively one sentence plus metadata), which prevents bloat, but the '[UNIFIED]' prefix appears to be internal tagging that serves no explanatory purpose. The single sentence earns its place but leaves substantial gaps.

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 complexity of OpenAPI specifications and the lack of an output schema, the description should explain what the tool returns (JSON/YAML format, version of OpenAPI, whether it includes extensions) and how it relates to the Directus instance configuration. Currently incomplete for a metadata-introspection 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?

Schema coverage is 0% and the required 'site' parameter is completely undocumented. The description fails to compensate by not explaining what 'site' represents (URL, identifier, or name) or providing an example, leaving users to guess the format of this critical input.

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 identifies the action ('Get') and resource ('OpenAPI specification'), providing basic orientation. However, it fails to specify the scope (e.g., whether this retrieves the spec for the Directus instance's own REST API) or distinguish nuances from similar schema-related siblings like 'directus_get_schema_snapshot' or 'directus_get_graphql_sdl'.

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 guidance is provided on when to use this tool versus alternatives, prerequisites (such as authentication requirements), or what to do with the returned specification. The '[UNIFIED]' prefix is unexplained metadata that adds no actionable context.

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