Skip to main content
Glama

update_entity

Idempotent

Update or create entity metadata in the ontology database by entity type and code, with optional name overrides and metadata merging after initial registration.

Instructions

Update or create an entity in the ontology database.

This is an admin tool for updating entity metadata after initial registration.

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": "update_entity"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeYesEntity canonical identifier (ISO code, ticker, classification code)
name_enNoOptional English name override
name_zhNoOptional Chinese name override
metadataNoOptional metadata dict (merged with existing)
entity_typeYesEntity type (country, stock, industry, etc.)

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already disclose that this is not read-only, not destructive, idempotent, and closed-world. The description adds that it is an admin tool and is intended for post-registration metadata updates, but it does not explain creation side effects, permission requirements, or what 'create' does beyond the existing schema.

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?

The description is two sentences and front-loads the main action. The second sentence adds useful admin and lifecycle context, though 'update or create' in the first sentence creates a small ambiguity.

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?

The tool has rich structured data: full parameter descriptions, annotations, and an output schema. The description is adequate for basic use but does not resolve the key selection ambiguity with add_entity or clarify what creating an entity means in this admin context.

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 100%, so the schema already documents all five parameters, including that metadata is merged with existing values. The description adds no parameter-specific meaning beyond what is in the 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?

The description states a specific verb and resource: updating or creating an entity in the ontology database. It is clear what the tool does at a high level, but the phrase 'update or create' blurs the boundary with siblings such as add_entity.

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?

The description provides lifecycle context by calling it an admin tool for updating entity metadata after initial registration. However, it gives no explicit guidance on when to choose this tool over add_entity, update_concept, or get_entity, and the 'or create' behavior makes the intended usage less precise.

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