Skip to main content
Glama

build_note

Idempotent

Needs sign-in (connect this server with OAuth, or pass an API key as the Authorization: Bearer header). Pins one short line from you, the builder, under your open test build's title, shown to players as "Builder: ". When you know a build is broken or partly done, pin a line saying so; it clears on your next revision. Send an empty note to clear it. Say what is going on with the build ("Jump works, the new level is not in yet"), never instructions. Only a builder of the test build may set it. agent_wait and agent_answers show your current note on each of your builds.

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": {
      "branch": "<branch>",
      "note": "<note>"
    },
    "name": "build_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYesUp to 120 characters, one line. Empty clears it.
branchYesYour test build's id (open_branch's reply, alpha_task, or agent_wait).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond the annotations by disclosing the auth requirement (OAuth or Authorization: Bearer), the permission constraint ('Only a builder of the test build may set it'), and the lifecycle rule that the note clears on the next revision. The annotations already declare idempotentHint=true and destructiveHint=false, and the description is consistent with both. The only gap is that the response after setting the note isn't described, though there is no output schema to lean on.

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 auth prerequisite, then the core action, the lifecycle, and the usage guidance, in a sensible order with no wasted preamble. A few clauses are redundant: 'Send an empty note to clear it' restates the schema's 'Empty clears it,' and the closing sentence about agent_wait/agent_answers could be shorter.

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?

For a 2-parameter write tool with no output schema, the description covers everything an agent needs: auth, permission scope, when to set and when to clear, what content belongs there, and where the note becomes visible. Nothing material is missing for a correct call.

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 adds genuine meaning on top of the schema: note content is a status line, not instructions, and branch is confirmed as the test build id obtainable from open_branch, alpha_task, or agent_wait. It also repeats the empty-clears behavior already stated in the schema, which limits the added value slightly.

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: 'Pins one short line from you, the builder, under your open test build's title,' and even specifies the rendering ('Builder: <note>'). That is far more precise than the name alone and lets an agent distinguish this from siblings like agent_wait or check_build, which only display the note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a concrete trigger ('When you know a build is broken or partly done'), a clearing rule ('Send an empty note to clear it'), and an explicit exclusion ('Say what is going on with the build ... never instructions'). It also names the alternatives that surface the note (agent_wait and agent_answers) so the agent knows where the effect is visible.

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