Skip to main content
Glama

create_record

Create a record in a collection. It is normally published immediately. data must match the collection schema (inspect it with describe_resource). Returns the resource_key to use with get_record/update_record. In a collection with screening, the record may become readable only after screening; the result then reports published: false and delivery: "pending". Requires the CREATE permission on this API.

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": {
      "collection": "<collection>",
      "data": "<data>"
    },
    "name": "create_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyNoOptional external identifier for deduplication; creating a second record with the same key returns a conflict.
dataYesDocument body matching the collection schema.
parentsNoParent placeholders for nested collection resource_ids.
collectionYesCollection resource_id from discover_resources.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnly=false, destructive=false, idempotent=false) by disclosing the default publish behavior, the screening edge case where a record may not be readable immediately, and the concrete result markers `published: false` / `delivery: "pending"`. The CREATE permission requirement is exactly the kind of auth context annotations cannot convey.

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?

Front-loads the core action, then layers returns, edge case, and permissions in a tight sequence with no filler. A couple of sentences could merge (the schema-matching note overlaps the schema's own `data` description), but overall density is high.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Even without an output schema, the description defines the return value (resource_key) and the conditional result flags, and covers permission and screening behavior for a mutation tool. Nothing an agent needs to invoke it correctly or interpret the response is missing.

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 baseline is 3, but the description adds meaning by tying `data` to the collection schema and pointing at describe_resource as the way to obtain that contract. It says nothing about `key` or `parents`, but both are already documented in the schema, so nothing critical is lost.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Create a record in a collection') and immediately distinguishes itself from siblings by naming get_record/update_record as consumers of the returned resource_key and describe_resource as the schema source. An agent can tell it apart from query_records/search_records without opening any schema.

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 clear preconditions: inspect the collection schema with describe_resource first, and hold CREATE permission on the API. It implicitly routes modification to update_record and reads to get_record via the returned key, but never states an explicit exclusion (e.g. 'to modify an existing record use update_record instead').

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