Skip to main content
Glama
iit-mcp-hudu

iit-mcp-hudu

Get Api Info

hudu_get_api_info
Read-only

Retrieve Hudu API information documents, optionally scoped by identifier; omit identifier for tenant-wide details and set expand to return full records instead of summaries.

Instructions

Return the API information document. Prefer api_info.get. Omit identifier for the tenant-wide document; expand:true returns the full record.

Input Schema

NameRequiredDescriptionDefault
optsNo
identifierNo

Output Schema

NameRequiredDescriptionDefault
foundYes
recordYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.6.0
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / identifier / anyOf
      Previous value: -[
      -  {
      -    "exclusiveMinimum": 0,
      -    "maximum": 9007199254740991,
      -    "type": "integer"
      -  },
      -  {
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  {
      -    "properties": {
      -      "domain": {
      -        "description": "Domain, for resources that have one.",
      -        "type": "string"
      -      },
      -      "external_id": {
      -        "description": "Vendor-side external id.",
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "Numeric id - the direct fetch.",
      -        "exclusiveMinimum": 0,
      -        "maximum": 9007199254740991,
      -        "type": "integer"
      -      },
      -      "name": {
      -        "description": "Exact name.",
      -        "type": "string"
      -      },
      -      "slug": {
      -        "description": "Exact slug.",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "exclusiveMinimum": 0,
      +    "type": "integer"
      +  },
      +  {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "properties": {
      +      "domain": {
      +        "type": "string"
      +      },
      +      "external_id": {
      +        "type": "string"
      +      },
      +      "id": {
      +        "exclusiveMinimum": 0,
      +        "type": "integer"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "slug": {
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  }
      +]
    • removedInput schema / properties / identifier / description
      Removed value: -"Optional identifier; omit it for the tenant-wide api info."
    • changedInput schema / properties / opts / properties / expand / description
      Previous value: -"Return the full typed records instead of the compact summaries (default false)."New value: +"Full records, not compact summaries."
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.2.3

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds useful behavior about tenant-wide versus identified documents and expanded records, but does not discuss auth needs, rate limits, or other operational nuances.

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

Conciseness5/5

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

Three short sentences, front-loaded with the primary action and followed by routing and parameter guidance. Every sentence has a clear purpose.

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

Completeness3/5

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

An output schema and annotations reduce what the description must cover, and it explains the main tenant-wide/expand behavior. However, given the complex `identifier` parameter and 0% schema description coverage, the description leaves a meaningful gap about how to specify a non-tenant document.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the burden for both parameters. It clarifies that omitting `identifier` yields the tenant-wide document and that `expand:true` returns full records, but it never explains what `identifier` represents or which of its many accepted forms (integer, string, or object with id/name/slug/domain/external_id) should be used.

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 and resource: 'Return the API information document.' This is clearly distinct from the generic sibling tools such as hudu_read, hudu_search, and hudu_list, which do not target API metadata.

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

Usage Guidelines4/5

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

Gives explicit usage guidance: 'Prefer api_info.get' names an alternative, and 'Omit `identifier` for the tenant-wide document; expand:true returns the full record' clarifies key invocation choices. It lacks explicit when-not-to-use guidance but is otherwise clear.

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