Skip to main content
Glama

Idhall Get Endpoint Spec

idhall_get_endpoint_spec

Retrieves the full schema for an IDhall endpoint—parameters, payload, classes, and response—from the local catalog or API when missing, so you can build accurate requests.

Instructions

Retourne le schéma complet (paramètres, payload, classes, réponse) d'un endpoint IDhall.

Lit d'abord le catalogue local ; interroge /api/v1/reference/endpoints/{endpoint_id} si absent. Exemple d'endpoint_id : GET__ideas, POST__ideas, PATCH__ideas__(id).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "endpoint_id": "<endpoint_id>"
    },
    "name": "idhall_get_endpoint_spec"
  }
}

Input Schema

NameRequiredDescriptionDefault
endpoint_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does disclose a useful behavioral trait: it reads a local catalog first and only queries /api/v1/reference/endpoints/{endpoint_id} when the entry is absent, implying a possible network call. It omits whether the operation is strictly read-only, how it fails on an unknown endpoint_id, and any auth or rate-limit considerations.

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?

Three short, front-loaded lines: purpose first, then the resolution strategy, then the ID format example. No filler, though the example line could have been folded into the parameter discussion more tightly.

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?

An output schema exists, so return values need not be spelled out, yet the description still enumerates what the schema contains (parameters, payload, classes, response). For a single-parameter lookup tool this is nearly complete; the main gap is error behavior for unknown IDs.

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 0% for the single parameter, so the description must compensate, and it does by giving concrete endpoint_id examples (GET__ideas, POST__ideas, PATCH__ideas__(id)) that reveal the METHOD__resource naming convention. It falls short of stating whether the value is case-sensitive or how path parameters are encoded beyond the parenthetical form.

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

Purpose4/5

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

The description states a specific verb and resource: it returns the complete schema (parameters, payload, classes, response) of an IDhall endpoint. That is clearly distinct from data-fetching siblings such as idhall_get_idea or idhall_search_endpoints, though no sibling is named explicitly for contrast.

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

Usage Guidelines3/5

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

Usage is only implied: the agent learns it should call this to learn an endpoint's contract, and learns the local-catalog-then-remote fallback. There is no explicit guidance on when to prefer this over idhall_search_endpoints (to discover IDs) or idhall_api_request (to actually execute a call).

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