Skip to main content
Glama
msoukhomlinov

iit-mcp-hudu

Describe One Operation

hudu_describe_operation
Read-only

Returns one operation's input schema, effects, flags, dry-run support, errors, related operations, and preferredWhen guidance so you can call it correctly after listing operations.

Instructions

Return the full input schema, effect, flags, dry-run support, error vocabulary, related operations and preferredWhen guidance for ONE operation, so a capability can be called correctly without carrying every schema in context. Use it after hudu_list_operations named the operation and before hudu_read/hudu_write/hudu_delete. Takes the canonical operation key exactly as the catalog prints it (for example "companies.update") — never a tool name, and there is no fuzzy matching: an unknown key is a CONFIG_ERROR naming the nearest catalog keys.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationYesCanonical operation key exactly as hudu_list_operations prints it, e.g. "companies.update". Never a tool name; there is no fuzzy match.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
opYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description still adds real behavior beyond that: no fuzzy matching, and an unknown key yields a CONFIG_ERROR naming the nearest catalog keys. It is only mildly incomplete on return shape, which the output schema covers.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads what the tool returns and then the routing, with no filler sentence. The long em-dash aside about key format is dense but each clause carries distinct information, so it is appropriately sized rather than wasteful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description need not enumerate return values, and it covers the remaining gaps: when to call it, key format, and error behavior. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds semantics the schema does not carry: the CONFIG_ERROR failure mode for unknown keys and the explicit 'never a tool name' prohibition. It does partly repeat the schema's own property description, keeping it short of a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Return) and a precisely enumerated resource (input schema, effect, flags, dry-run support, error vocabulary, related operations, preferredWhen) scoped to ONE operation, and explicitly contrasts itself with hudu_list_operations and hudu_read/write/delete. An agent can identify it without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit sequencing: 'Use it after hudu_list_operations named the operation and before hudu_read/hudu_write/hudu_delete.' Both the predecessor and the successors are named, which is exactly the routing an agent needs.

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