Skip to main content
Glama

create_entity

Define a new data entity under a project. CRUD endpoints at {base}/{customer_slug}/{project_slug}/{entity_name} activate immediately. The key must be a unique 3-character UPPERCASE string (e.g. 'ORD' for orders). Pass fields to create its fields in the same call (one bulk request) instead of a create_field per field.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesUnique 3-character UPPERCASE ID prefix. Example: 'ORD' produces ORD1, ORD2.
nameYesSlug-style entity name used in URL paths. Lowercase alphanumeric with hyphens/underscores, 3-50 chars. Example: 'orders', 'line-items'
labelNoSingular display name, e.g. 'Order'
fieldsNoOptional: the entity's fields, created in one bulk call right after the entity itself — the normal way to define an entity. Each item is shaped like create_field's arguments (minus entity_id). When given, the result is {"entity": <entity record>, "fields": <create_fields result>}; the entity is kept even if some fields failed — fix those with create_fields.
methodsNoAllowed HTTP methods. Defaults to all. Does not restrict any custom endpoints (create_endpoint) attached to this entity — a route's own method is independent of this list.
project_idNoProject record ID (e.g. 'PRJ3'). Optional if whoami returned a default_project_id — falls back to that; pass explicitly to target a different project. Otherwise get it from whoami or list_projects.
descriptionNoFree-text description shown in OpenAPI spec
plural_labelNoPlural display name, e.g. 'Orders'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly=false / destructive=false / idempotent=false, so the safety bar is lower. The description still adds real behavior beyond them: CRUD endpoints activate immediately upon creation (a live side effect), and the key is a unique 3-char UPPERCASE constraint. It does not mention duplicate-key errors or naming collisions, so not full marks.

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 tight sentences, front-loaded with the action, then the side effect, then the field-bulk tip. Nothing is wasted, though the key-format sentence duplicates the schema param description rather than adding new information.

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 an 8-parameter creation tool with no output schema, the description covers purpose, side effect, and the highest-leverage parameter (fields). Undescribed in the prose are `methods`, project_id fallback, and the returned shape, but those are documented in the schema. Adequate overall, with modest gaps.

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 100%, so the baseline is 3. The description genuinely adds meaning on the `fields` argument by framing it as a single bulk request that replaces N create_field calls, and pins the key format constraint. The key restatement is redundant with the schema, hence 4 rather than 5.

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 + scope: 'Define a new data entity under a project.' It also catches the edge case by pointing at the internal alternative ('instead of a create_field per field'), which helps disambiguate from siblings. It does not, however, explicitly contrast with update_entity/delete_entity, so the sibling differentiation is partial.

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 a clear situation for use (defining a new entity) and explicitly names a routing decision: use the bulk `fields` argument rather than calling create_field repeatedly. There are no explicit 'when not to use' exclusions (e.g. use update_entity to modify an existing one), so it stops short of a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources