Skip to main content
Glama

gograph_review

Read-onlyIdempotent

Review changed Go symbols, covering tests, routes, env vars, and SQL risk after edits to verify blast radius before committing or auditing all uncommitted changes.

Instructions

Summarize the scope and risk profile of a change: which symbols changed, which tests cover them, which routes and env vars they touch, and whether SQL is involved. The MCP server checks freshness before this call and refreshes in the current requested analysis mode; precise and precise_fallback graphs retry CHA/SSA after source changes. Read-only; no side effects. Requires either symbol or uncommitted=true. WHEN TO USE: After editing — as a post-edit verification step before committing; confirms the blast radius matches expectations. Use uncommitted=true to review all current unstaged changes at once. NOT TO USE: For boundary constraint enforcement (use gograph_boundaries); for pre-edit planning (use gograph_plan). RETURNS: JSON with changed_symbols[], tests[], routes[], env[], errors[], and a risk object (public_api, touches_sql, touches_routes, touches_env). Uncommitted modes compare declarations against HEAD, including selected untracked Go files. Traversal consumers refuse deleted declarations requiring historical caller evidence. Review instead includes changes --git HEAD declaration evidence and names unavailable historical callers, tests and risk. Incomplete comparisons and missing/ambiguous current identities remain errors. Rebuild before traversing newly added symbols.

Input Schema

NameRequiredDescriptionDefault
rootNoAbsolute path of the checkout you are working in (your cwd or git worktree). Must be this server's repository or one of its git worktrees; the answer then comes from that checkout's own graph. A path elsewhere is refused. Alias: cwd. Omit only when the configured checkout is the one you mean.
symbolNoThe name of the target symbol to run the design review for (e.g. 'AuthService')
intentionNoTechnical rationale, required for analytical calls selecting an active session.
session_idNoCaller selector returned by session_create. Omission means an independent caller; never inherits server environment or another caller's session.
uncommittedNoSet to true to review all uncommitted/modified changes in the repository

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.7.18
    • addedInput schema / properties / intention
      Added value: +{
      +  "description": "Technical rationale, required for analytical calls selecting an active session.",
      +  "type": "string"
      +}
    • addedInput schema / properties / root
      Added value: +{
      +  "description": "Absolute path of the checkout you are working in (your cwd or git worktree). Must be this server's repository or one of its git worktrees; the answer then comes from that checkout's own graph. A path elsewhere is refused. Alias: cwd. Omit only when the configured checkout is the one you mean.",
      +  "type": "string"
      +}
    • addedInput schema / properties / session_id
      Added value: +{
      +  "description": "Caller selector returned by session_create. Omission means an independent caller; never inherits server environment or another caller's session.",
      +  "type": "string"
      +}
  2. Addedv1.5.3
  3. Removedv1.5.3
  4. Changed2 schema fields changedv1.4.70
    • changedInput schema / properties / symbol / description
      Previous value: -"The symbol to review"New value: +"The name of the target symbol to run the design review for (e.g. 'AuthService')"
    • changedInput schema / properties / uncommitted / description
      Previous value: -"Set to true to review all uncommitted changes"New value: +"Set to true to review all uncommitted/modified changes in the repository"
  5. First observedv1.0.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/non-destructive annotations, it discloses freshness handling (server checks freshness and refreshes in the current analysis mode; CHA/SSA retried after source changes on precise graphs), how uncommitted mode compares declarations against HEAD including selected untracked Go files, and how incomplete comparisons and ambiguous identities become errors. The 'Read-only; no side effects' line merely restates annotations but does not contradict them.

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?

Purpose, preconditions, WHEN/NOT TO USE, and RETURNS are front-loaded and clearly delimited. However, the middle section on CHA/SSA retries and 'traversal consumers refuse deleted declarations requiring historical caller evidence' is jargon-dense and hard to parse quickly, and the final 'Rebuild before traversing newly added symbols' reads as an operational aside.

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?

With no output schema, the description usefully enumerates the returned JSON fields (changed_symbols[], tests[], routes[], env[], errors[], risk{...}), plus freshness, error handling, and mode behavior — enough for a 5-parameter analytical tool. The remaining gap is that the deleted-declaration and historical-caller handling is stated ambiguously rather than as a clear agent-facing rule.

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, but the description adds a cross-parameter constraint the schema cannot express (symbol XOR uncommitted=true) and explains repository-scoped semantics of the root parameter ('must be this server's repository or one of its git worktrees'). It does not elaborate on intention/session_id, which remain schema-documented only.

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 — summarising the scope and risk profile of a change — and enumerates the concrete dimensions covered (changed symbols, covering tests, routes, env vars, SQL involvement). This clearly distinguishes it from nearby siblings such as gograph_changes and gograph_risk, which cover narrower slices.

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?

It provides explicit WHEN TO USE guidance (post-edit verification before committing, or uncommitted=true to review all unstaged changes) and explicit NOT TO USE guidance naming the correct alternatives (gograph_boundaries for constraint enforcement, gograph_plan for pre-edit planning). A precondition is also stated: requires either symbol or uncommitted=true.

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