Skip to main content
Glama

retrieve_entity

Retrieve an entity from the catalog by its ID. Optionally truncate text fields for concise results.

Instructions

Retrieve an entity from the catalog by ID.

Args:
    entity_id: The ID of the entity to retrieve
    truncate_length: Maximum characters for text fields in results (default: 150).
        Often useful to set to None when you need full descriptions/definitions.

Returns:
    Entity details with text fields truncated to specified length

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesThe ID of the entity to retrieve
truncate_lengthNoMaximum characters for text fields in results. Often useful to set to None when you need full descriptions/definitions

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Discloses truncation behavior and default value, which is key behavioral context. No annotations provided, so description carries full burden. Lacks details on error handling (e.g., invalid ID) or response structure beyond 'Entity details'.

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?

Extremely concise: two sentences plus args/returns bullet. Front-loaded purpose, no fluff.

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?

Adequate for a simple retrieval tool with output schema. Explains truncation behavior but misses error states and does not address sibling context. Could be more complete given no annotations.

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%, so baseline is 3. Description rephrases schema descriptions but adds practical note on setting truncate_length to None for full content. Minimal added value beyond schema.

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?

Clearly states it retrieves an entity by ID, with parameters explained. However, does not differentiate from sibling get_* tools like get_collection, get_question, get_resource, which also retrieve specific items by ID. The generic term 'entity' is ambiguous.

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

Usage Guidelines2/5

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

Provides truncation usage hints but no guidance on when to use this tool vs alternatives like search_data_assets or list tools. No when-not-to-use or exclusion criteria.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mbrummerstedt/secoda-analysis-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server