Skip to main content
Glama

outline

Inspect a code file or directory structure without reading it, including classes, methods with line ranges, and categorized calls; target one method to view its call graph.

Instructions

Structure of a code file or directory without reading it: classes/components, methods with line ranges, calls by category. With method: that one method's call graph. Start here once you know the file (else locate). Example: {"path": "app/Order.php", "method": "cancel"}. Pitfall: give the method in method, not as path::method; on a large directory use format: summary or a subdirectory.

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": {
      "path": "<path>"
    },
    "name": "outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
fullNoDisable the 400-line output cap (use only when needed).
pathYesFile or directory, relative to the project root.
layerNoOnly files of this layer (see `project_profile`), e.g. `service`, `service,repository`, or one ecosystem: `controller:js`.
formatNooutline (default): classes, methods with line ranges, calls by category; api: public surface; flow: control branches; summary: one line per file; hotspots: most-called; stats: counts.
methodNoOnly this method/function (file paths only).
projectNoRegistered project alias (see `projects`); default: the server's working directory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.3

TDQS

A4.5/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 it discloses the key behavioral trait that output is a structural outline rather than file contents. It also surfaces the 400-line cap behavior (though `full` is documented in the schema) and the mode-switching effect of `method`. It stops short of stating read-only/safety semantics or output volume expectations explicitly, which keeps it from a 5.

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 the core purpose, then mode behavior, routing, an example, and a pitfall — each sentence earns its place. It is dense with backticked identifiers but not padded; minor cost is that the pitfall and format advice compete for attention at the end.

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 6-parameter read tool with no annotations and no output schema, the description covers purpose, routing, mode behavior, an example, and the main misuse pitfall. Remaining gaps (what exactly the call-graph output looks like, output size behavior) are modest and partly covered by the schema's format descriptions.

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 would be 3, but the description adds real meaning: `method` yields that one method's call graph, and the pitfall clarifies that the method name belongs in `method` rather than encoded as `path::method` — a misuse the schema alone would not prevent. The format guidance for large directories also adds practical semantics beyond the enum descriptions.

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+resource: returns the structure of a code file or directory (classes/components, methods with line ranges, calls by category) without reading contents. It also carves out the `method` mode as producing a single method's call graph, which lets an agent distinguish it from siblings like `method_body` or `search` without opening schemas.

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?

Explicitly routes the agent: "Start here once you know the file (else `locate`)" names the alternative and the condition that selects it. It adds a second routing rule for large directories (use `format: summary` or a subdirectory) and a concrete invocation example.

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