Skip to main content
Glama
Sign In
gograph

gograph

by ozgurcd
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

gograph_envs

Read-onlyIdempotent

Find all environment variable reads in a Go codebase with calling function and file location. Filter by key substring to document required vars or audit secret access.

Instructions

Find all environment variable reads in the codebase via os.Getenv, os.LookupEnv, and common config frameworks, with their enclosing function context. 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. Optional term filters by key name substring (e.g., "DATABASE" matches DATABASE_URL and DATABASE_HOST). WHEN TO USE: When compiling a deployment configuration manifest, documenting required env vars, or auditing what secrets a service reads at startup. NOT TO USE: For reading actual runtime env values (this is static analysis); for database queries (use gograph_sql). RETURNS: List of env key names, calling function, and file/line; empty when no env reads match the filter.

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.
termNoOptional filter term (e.g., 'DATABASE' matches DATABASE_URL, DATABASE_HOST, etc.)
limitNoMaximum rows per page; the byte budget may return fewer.
cursorNoOpaque next_cursor for the same graph snapshot and result selection.
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.

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. 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"
+}
  3. Addedv1.5.3
  4. Removedv1.5.3
  5. First observedv1.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so "Read-only; no side effects" is largely redundant. However, the description adds genuinely non-obvious behavior: the server checks freshness before the call, refreshes in the requested analysis mode, and retries CHA/SSA for precise and precise_fallback graphs after source changes. That freshness/retry detail is the kind of context annotations cannot carry.

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?

Front-loaded with purpose, then structured WHEN TO USE / NOT TO USE / RETURNS blocks, so an agent can scan quickly. The freshness sentence ("precise and precise_fallback graphs retry CHA/SSA after source changes") is dense internal terminology that costs a little more than it returns for callers who only need to know results are current.

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?

Six optional parameters are fully documented in the schema, and with no output schema the description supplies a RETURNS block covering key names, calling function, file/line, and the empty-result case. Combined with the freshness note and the static-analysis caveat, 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 the baseline is 3. The description only restates the `term` substring filter with an example that already appears verbatim in the schema for `term`, and says nothing about `root`, `limit`, `cursor`, `session_id`, or `intention`, leaving the schema to do all parameter work.

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 first sentence states a specific verb and resource ("Find all environment variable reads") and names the concrete detection surfaces (os.Getenv, os.LookupEnv, config frameworks) plus the enclosing-function context. It is clearly distinguishable from siblings such as gograph_sql and gograph_strings, which scan other artifact types.

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?

There is an explicit WHEN TO USE block (deployment config manifests, required env var documentation, secret-read auditing at startup) and an explicit NOT TO USE block that routes runtime-value needs and database queries elsewhere, naming gograph_sql directly. Nothing is left to inference.

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