Skip to main content
Glama

get_api_surface

Generates a compact markdown map of all exported interfaces, classes, and types in a project without crawling files, so agents can grasp an API surface fast.

Instructions

Generates and returns a compact markdown map of all exported interfaces, classes, and types in the project without crawling files.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_api_surface"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_pathNoOptional root path of the project (defaults to active workspace, or pass '.' or absolute path)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.8.4

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It usefully discloses the output format (compact markdown) and a key performance trait (no file crawling), but says nothing about read-only safety, scope of 'exported' (does it include re-exports or private types), or behavior on a nonexistent path.

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?

A single front-loaded sentence with zero filler; the scope ('exported'), the output form ('compact markdown map'), and the cost characteristic ('without crawling files') are all packed in without repetition.

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 simple, zero-required-argument inspection tool with no output schema and no annotations, the description covers what it returns and how it avoids expensive crawling, which is enough to call it correctly. It stops short of stating the safety profile or the edge-case behavior on missing paths.

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?

There is only one optional parameter and the schema already documents it at 100% coverage, including the default-workspace and '.'/absolute-path conventions. The description adds essentially no parameter meaning beyond what the schema provides, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Generates and returns a compact markdown map of all exported interfaces, classes, and types'), which is far more informative than the bare name. It also distinguishes itself behaviorally from crawling-based siblings via 'without crawling files', though it never names an alternative tool explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can infer this is the lightweight way to get a project overview, but there is no explicit 'use this when' clause, no exclusion of when get_architecture_graph or scoped_search is preferable, and no stated prerequisites.

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