Skip to main content
Glama

get_api_surface

Lists exported symbols and public APIs from source files to analyze code dependencies and interfaces across multiple frameworks and languages.

Instructions

List all exported symbols (public API) of a file or matching files

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_patternNoGlob-style pattern to filter files (e.g. src/services/*.ts)
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool lists symbols but doesn't describe the output format (e.g., list of names, structured data), pagination, rate limits, or any side effects. For a tool with no annotation coverage, this leaves significant gaps in understanding how it behaves.

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?

The description is a single, efficient sentence that front-loads the core purpose without unnecessary words. It avoids redundancy and gets straight to the point, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what the output looks like (e.g., format, structure) or any behavioral nuances, which is critical for an AI agent to use the tool effectively. The description alone is insufficient for a tool with no structured context.

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?

The description mentions 'file or matching files,' which aligns with the 'file_pattern' parameter in the schema. Since schema description coverage is 100%, the schema already documents the parameter fully. The description adds minimal value beyond what the schema provides, meeting the baseline for high coverage.

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 description clearly states the action ('List') and the target ('exported symbols (public API) of a file or matching files'), specifying both the resource (symbols) and scope (file/matching files). It distinguishes itself from siblings like 'get_symbol' or 'get_outline' by focusing on public API exports rather than general symbol information or code structure.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, typical use cases, or how it differs from similar tools like 'get_symbol' (which might retrieve details about a specific symbol) or 'get_outline' (which might provide a broader structural overview).

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nikolai-vysotskyi/trace-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server