Skip to main content
Glama
ozgurcd

gograph

by ozgurcd
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

gograph_public

Read-onlyIdempotent

List exported symbols of a Go package to inspect its public contract, build integration docs, or see what callers can access.

Instructions

List all exported (public) symbols of a specific package, including functions, methods, types/interfaces, variables, and constants. 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. WHEN TO USE: When reviewing a package's public contract before changing it, building integration documentation, or checking what a package exposes to callers. NOT TO USE: For unexported/private symbols (use gograph_node or gograph_focus); for API drift detection against a baseline (use gograph_api). RETURNS: List of exported symbol names with kinds and file locations; empty when the package has no exports or is not found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum rows per page; the byte budget may return fewer.
cursorNoOpaque next_cursor for the same graph snapshot and result selection.
packageYesThe package name or path to inspect (e.g., 'internal/auth')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.7.5
    • addedInput schema / properties / cursor
      Added value: +{
+  "description": "Opaque next_cursor for the same graph snapshot and result selection.",
+  "maxLength": 128,
+  "type": "string"
+}
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 100,
+  "description": "Maximum rows per page; the byte budget may return fewer.",
+  "maximum": 200,
+  "minimum": 1,
+  "type": "integer"
+}
  2. Addedv1.5.3
  3. Removedv1.5.3
  4. Changed1 schema field changedv1.4.66
    • changedInput schema / properties / package / description
      Previous value: -"The package name (e.g., 'auth')"New value: +"The package name or path to inspect (e.g., 'internal/auth')"
  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?

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description goes beyond that by disclosing the server-side freshness check and refresh in the current analysis mode, and the CHA/SSA retry after source changes, plus empty-result semantics — meaningful operational behavior not captured by annotations.

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?

Front-loads the core purpose, then uses clearly delimited WHEN TO USE / NOT TO USE / RETURNS blocks. Each sentence carries distinct information (scope, freshness behavior, routing, empty-result behavior) with no redundancy.

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?

With no output schema, the description compensates by describing the return shape (exported symbol names with kinds and file locations, empty when no exports or package not found). Combined with annotation coverage and freshness notes, an agent has everything needed to call it correctly.

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 100%, so package, limit, and cursor are already documented in the schema (including the byte-budget note and opaque cursor semantics). The description adds no parameter-level detail beyond that, so the baseline 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 ('List all exported (public) symbols of a specific package') and enumerates the kinds returned (functions, methods, types/interfaces, variables, constants). It also scopes itself against siblings by naming the private-symbol and drift alternatives, so an agent can distinguish it without opening a schema.

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?

Contains explicit WHEN TO USE (reviewing a package's public contract, integration docs, checking exposure) and NOT TO USE conditions with named alternatives: gograph_node/gograph_focus for unexported symbols and gograph_api for drift against a baseline. This is textbook routing guidance.

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

Deploy Server

Other Tools