Skip to main content
Glama

Describe a GWIX ID

describe_id
Read-onlyIdempotent

Use to explain a GWIX ID returned by another tool (for example a location, company or soc_2018:... occupation ID): what it is, its parent and its attributes. Not for finding an ID from a name; use find_id for that. Returns the ID's name, type, parent IDs and attributes. What a GWIX ID means: name, parents and attributes (roles, job families, SOC occupations, companies, industries, locations, job levels).

Input Schema

NameRequiredDescriptionDefault
idYesThe GWIX ID exactly as another tool returned it, e.g. soc_2018:29-1141.
dimensionYesThe kind of ID: location for a place ID, company for a company ID, soc_occupation for soc_2018:... codes, and so on.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so safety is covered. The description adds value the annotations cannot: it discloses what comes back (name, type, parent IDs, attributes) in the absence of an output schema. It stops short of saying what happens with a malformed or unknown ID, which is the remaining gap.

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

Conciseness3/5

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

Front-loaded correctly with the usage and the exclusion up front, but the closing sentence ('What a GWIX ID means: name, parents and attributes...') restates the earlier 'Returns the ID's name, type, parent IDs and attributes' almost verbatim. That redundancy and the trailing parenthetical list of dimensions cost it.

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 no output schema, the description usefully describes the return payload, and both required params are fully specified in schema, so an agent has enough to call it correctly. Only failure semantics for an unresolvable ID are unaddressed, which is minor for a read-only lookup.

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

Parameters3/5

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

Schema coverage is 100% with an enum and per-field descriptions, so the schema already carries the load and baseline 3 applies. The description only loosely reinforces this by giving 'location, company or soc_2018:... occupation ID' as examples, which the schema states more precisely — no new syntax or format rules are added.

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 ('explain a GWIX ID returned by another tool') and immediately names what the tool is not for, pointing at sibling find_id. An agent can distinguish it from all 12 siblings without opening a 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?

Explicit routing both ways: use this when you already have an ID from another tool; do not use it to go from a name to an ID — use find_id instead. The exclusion plus named alternative is exactly the guidance pattern that prevents misfires.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources