Skip to main content
Glama

Outline the code

files_outline
Read-onlyIdempotent

Map the code WITHOUT reading it: every function, class, export and route with its line number, for one file or a whole folder. Call this BEFORE reading anything, to find where to look, then files.read only the part you need. It costs a fraction of reading the files and it returns no bodies at all. JavaScript, TypeScript, Python, PHP, Go and JSON.

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": {
      "id": "<id>"
    },
    "name": "files_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
pathNoA file, or a directory to outline every source file under. Defaults to the project root.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), but the description adds behavior beyond them: cost relative to reading, absence of function bodies, and the supported language set. That is exactly the context an agent needs to justify the extra call.

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?

Three short sentences, front-loaded with the core capability and scoped immediately by the explicit read/outline alternative. The language list is a compact trailing sentence that costs little and helps routing.

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?

For a two-parameter read-only tool with no output schema, everything material is present: scope, output content, cost, language coverage, and workflow position. No return-value contract is needed because the description states no bodies are returned.

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 coverage is 50%; only `path` is documented in the schema, and the description reinforces it ('one file or a whole folder') without adding format or edge-case detail. The required `id` parameter is never explained in the description, so half the gaps remain unfilled.

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 ('map the code') with the exact payload: functions, classes, exports, routes plus line numbers, over a file or folder. Explicitly contrasts with reading ('WITHOUT reading it'), which separates it from files_read at a glance.

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?

Gives an explicit ordering rule ('call this BEFORE reading anything'), the reason ('to find where to look'), and the follow-up alternative ('then files.read only the part you need'). No ambiguity about when this tool is preferred over a plain read.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources