Skip to main content
Glama

get_entity

Read-onlyIdempotent

Retrieve one entity by exact type and code (e.g., ticker AAPL, country CN) when the identifier is known, avoiding search tools.

Instructions

Look up one entity by exact type+code (ticker AAPL, country CN). Use when the code is known; do not use search tools for this.

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": {
      "entity_type": "<entity_type>",
      "code": "<code>"
    },
    "name": "get_entity"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeYes
entity_typeYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare this a read-only, idempotent, closed-world, non-destructive operation, so safety is covered. The description usefully adds the exact-match constraint, which tells the agent there is no fuzzy or partial matching. It does not disclose what happens on a miss (error vs. null), which is the main behavioral question left open.

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?

Two short sentences, zero filler, with the core behavior front-loaded and the exclusion clause second. Every word earns its place.

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?

For a two-required-parameter lookup with rich annotations and an output schema covering return values, this is close to complete. The remaining gaps are the valid entity_type domain and not-found behavior, both minor for a tool this simple.

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 description coverage is 0%, so the description has to carry the parameter burden. It does so partially by giving example values that map each parameter to a format (entity_type: ticker/country; code: AAPL/CN), but it never enumerates valid entity_type values, so the agent could still pass an unsupported type.

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?

States a specific verb+resource ("Look up one entity") with the exact-match key it uses (type+code) and concrete examples ("ticker AAPL, country CN"). It implicitly separates itself from list/search-style tools but never names a specific sibling such as resolve_entity or list_entities.

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 an explicit when-to-use condition ("when the code is known") and an explicit when-not ("do not use search tools for this"). It stops short of naming the sibling to use when the code is unknown, so the agent must infer the routing from generic wording.

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