Skip to main content
Glama

Panel: note on a column

column_note
Destructive

Adds or edits a note on a result table column from its header; an empty note removes it.

Instructions

The user writes or edits the note on a result column's table column from its header in the results panel; an empty note removes it. App-only.

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": {
      "pull_id": "<pull_id>",
      "column": "<column>",
      "note": "<note>"
    },
    "name": "column_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYes
columnYes
pull_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, so the mutation profile is known. The description adds a genuinely useful behavioral detail beyond the annotations: an empty note removes the existing note, which is the specific destructive case an agent needs to avoid by accident. It does not cover permissions, what happens to a pre-existing note on overwrite, or any confirmation semantics.

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?

One dense but front-loaded sentence covering actor, action, target, and the removal edge case, followed by a terse qualifier. Nothing is redundant, though the single clause stacks several ideas and could be split for scanability.

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?

For a 3-required-parameter mutation with no output schema and zero schema coverage, the description is only partially complete: the destructive edge case is disclosed, but the identifier parameter, permission requirements, and success/return behavior are unaddressed.

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 description coverage is 0%, so the description must carry the parameter meaning itself. It does well for `note`, including the important empty-string-removes behavior, and implicitly defines `column` as a column in the result table, but `pull_id` (the identifying parameter) is never explained at all, leaving a required parameter undefined.

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 (writes or edits a note) on a specific resource (a result column's table column) and locates it in the UI (the column header in the results panel). An agent can distinguish it from a general note tool, though it never names or contrasts with siblings such as set_note or column_menu.

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

Usage Guidelines3/5

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

"App-only" and the framing "the user writes or edits... from its header" imply this is a UI-initiated action rather than an agent-driven one, which is useful usage context. However, there is no explicit when-to-use vs. when-not guidance and no named alternative for setting notes outside the results panel.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.