Skip to main content
Glama

update_project_notes

Update or overwrite the AI Context Notes pinned on a project workspace's dashboard banner. Returns the updated project object. Use this tool to persist architectural notes, API contract references, test session keys, or helper endpoint conventions so future AI sessions and human teammates have immediate project context (retrievable via get_project_context or list_projects).

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": {
      "projectId": "<projectId>",
      "userNotes": "<userNotes>"
    },
    "name": "update_project_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYesDatabase ID of the target project workspace (obtain from list_projects).
userNotesYesMarkdown or plain-text AI Context Notes to pin on the project dashboard banner. Replaces existing notes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / projectId / description
      Previous value: -"ID of the target project workspace"New value: +"Database ID of the target project workspace (obtain from list_projects)."
    • changedInput schema / properties / userNotes / description
      Previous value: -"The AI Context Notes text to pin on the project dashboard banner"New value: +"Markdown or plain-text AI Context Notes to pin on the project dashboard banner. Replaces existing notes."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose the key trait: notes are overwritten/replaced, not appended, and the call returns the updated project object. It omits permission/auth requirements and any concurrency or size-limit caveats, which is the main remaining gap for a mutation tool.

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?

Two sentences, front-loaded with the action and scope, followed by the return value and use cases. Every clause contributes routing or behavioral information; nothing is redundant.

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 a simple two-parameter mutation, the description covers what is changed, that it replaces existing content, what is returned, and how the notes are later retrieved. Missing only permission/size constraints, which are minor for this tool's complexity.

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

Parameters3/5

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

Schema coverage is 100%, so both parameters are already documented, including the replace semantics of userNotes. The description adds use-case meaning for the notes content but no syntax, format, or size guidance beyond the schema, so the baseline of 3 applies.

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: 'Update or overwrite the AI Context Notes pinned on a project workspace's dashboard banner,' plus what it returns. It also names the read-side siblings (get_project_context, list_projects), so an agent can distinguish write from read without inspecting schemas.

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 concrete when-to-use guidance by listing the kinds of content to persist (architectural notes, API contract references, test session keys, helper endpoint conventions). It does not state explicit exclusions or when to prefer another mutation tool, but the intended context is 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