Skip to main content
Glama

append_project_annotation

Idempotent

Append one annotation to project context. Append-only: goals, activation events, glossary entries, and existing annotations stay in place. Allowed fields are project, occurred_at (ISO-8601 timestamp, stored as UTC), title (max 120 characters), and an optional note (max 500 characters). The annotation identity is normalized occurred_at plus title. A duplicate returns 200 with appended false and keeps the stored note. The 100 annotation cap returns 409 and stores nothing. Use this for a meaningful landing page, pricing, onboarding, feature, release, or experiment change. Do not store git commit logs, noisy edits, PII, secrets, or long notes.

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": {
      "project": "<project>",
      "occurred_at": "<occurred_at>",
      "title": "<title>"
    },
    "name": "append_project_annotation"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteNoOptional short note, max 500 characters
titleYesShort annotation title, max 120 characters
projectYesProject name or ID
occurred_atYesISO-8601 timestamp when the major product change happened

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (which only state that it isn't read-only, that it's idempotent, and that it isn't destructive), the description discloses append-only semantics, duplicate handling (200 plus appended false, with the stored note preserved), the 100-annotation cap returning 409 without storing anything, and the identity rule (normalized occurred_at plus title). That is exactly the kind of behavior an agent needs in order to predict the outcome of a call that fails at the cap.

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?

The description is front-loaded with purpose, then behavior and error semantics, then usage guidance, and it ends with the exclusion list. Every sentence carries distinct information, with no filler or repeated claims.

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?

There is no output schema, so the description has to carry the burden of explaining the outcome, and it does: it covers the success path, duplicate results, and cap failure. Combined with the allowed fields, the identity rule, and the exclusions, an agent has everything needed to call this correctly.

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?

The schema's description coverage is 100%, so the baseline is 3; the description raises that by adding that occurred_at is stored as UTC and that identity is derived from normalized occurred_at plus title, which no field in the schema states. It also restates the field limits, which is mildly redundant but harmless.

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?

The description opens with a specific verb and resource ('Append one annotation to project context') and immediately defines the scope as append-only. That framing separates it from a general context-writing tool such as set_project_context without needing to name it.

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?

It gives explicit when-to-use criteria ('meaningful landing page, pricing, onboarding, feature, release, or experiment change') and explicit when-not-to-use exclusions ('git commit logs, noisy edits, PII, secrets, or long notes'). It doesn't point to a sibling for reading back annotations, but the positive and negative boundaries are unusually clear.

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