Skip to main content
Glama

Set Recipe Build Metadata

set_recipe_metadata
DestructiveIdempotent

Replace selected name, description, UI, or comment metadata on one private build.

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": {
      "build_ref": "<build_ref>",
      "revision": "<revision>",
      "idempotency_key": "<idempotency_key>",
      "metadata": "<metadata>"
    },
    "name": "set_recipe_metadata"
  }
}

Input Schema

NameRequiredDescriptionDefault
metadataYes
revisionYes
build_refYes
idempotency_keyYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so safety is covered structurally. The word 'Replace' with 'selected' fields adds useful partial-update semantics (only listed fields overwritten), but the description says nothing about permission requirements, what happens to unlisted metadata, or why idempotency matters here.

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?

A single front-loaded sentence with no filler, and the scope constraint follows directly behind the action. Nothing redundant is present.

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?

Output schema exists, so return values need not be explained, but for a destructive mutation with a nested object, a revision token, and an idempotency key, the one-sentence description leaves major gaps. The agent still cannot tell how revision must be obtained or what state preconditions apply.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry the load, yet it only names the metadata subfields (name, description, $ui, $comment) and ignores three top-level required parameters: build_ref, revision (a 64-hex token that looks like an optimistic-concurrency guard), and idempotency_key. Those unexplained parameters are exactly the ones an agent is most likely to get wrong.

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 and resource ('Replace ... metadata') plus scope ('on one private build') and enumerates the affected fields (name, description, UI, comment). This separates it from siblings like set_recipe_acceptance_cases or set_recipe_contracts, though it never explicitly names an alternative.

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?

No when-to-use or when-not-to-use guidance and no alternatives referenced; the closest thing is the scope phrase 'one private build', which hints that non-private builds are out of scope. It does not say whether the build must be in a particular state or whether update_recipe_build is the better choice for other edits.

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