Skip to main content
Glama

add_entity

Register a new entity in the data registry by specifying its type and code, with optional English and Chinese names plus metadata for identification and cataloging.

Instructions

Add a new entity to the registry.

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

Input Schema

NameRequiredDescriptionDefault
codeYes
name_enNo
name_zhNo
metadataNo
entity_typeYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already state readOnlyHint=false, idempotentHint=false, and destructiveHint=false, so the description adds nothing on the safety or repeat-call profile. Critically for a non-idempotent create, it does not say whether re-adding the same code creates a duplicate, errors, or merges, which is exactly the behavioral context only the description could supply.

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?

It is a single front-loaded sentence with no filler, so there is no verbosity problem. The issue is the opposite: it is too terse to be useful, which is under-specification rather than good concision.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/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 explained, but the tool is a five-parameter, non-idempotent mutation with zero schema documentation and the description fills none of that gap. An agent could not call this correctly without opening the schema and guessing at the semantics of 'code' and 'entity_type'.

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

Parameters1/5

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

Schema description coverage is 0% across five parameters, so the description carries the full burden and provides none of it. It never explains what 'code' means, what values 'entity_type' accepts, how name_en/name_zh differ, or what 'metadata' is for.

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 names a specific verb and resource ('Add a new entity') and its target ('to the registry'), so an agent knows this creates a registry entry. It does not distinguish itself from close siblings such as add_entity_identifier, add_relationship, or update_entity, leaving the agent to infer why this tool versus those.

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?

There is no when-to-use guidance: nothing says when to add a new entity versus updating an existing one or attaching an identifier via add_entity_identifier. No prerequisites, no exclusions, no mention of what happens if the entity already exists.

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