Skip to main content
Glama

spec_nav_functions

Catalog functions in files, directories, or services without bodies: names, signatures, line ranges, export status, and docs. Filter by service, file, name, kind, or language; page results.

Instructions

Function catalog of a file, directory or service without bodies: qualified name, kind, signature, line range, export status, doc summary and id. Filter by services, file, name, kind, language. Paged; a coverage line names the files not read (syntax errors, unsupported languages, skipped), and the catalog is complete only when it says so. Inline anonymous callbacks are counted, not listed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNoOnly files whose path contains this, matches it as a * glob, or as a regex (/…/, or a value with | ( ^ $ \, e.g. "services/(order|payment)").
kindNoe.g. "method", "function", "constructor", "arrow"
nameNoCase-insensitive substring of the qualified name, or /regex/.
limitNoFunctions per page (default 200, max 1000).
cursorNoThe nextCursor from the previous page. Repeat the other arguments unchanged.
formatNo"text" (default, compact) or "json" (structured).
languageNo
servicesNoServices/directories relative to the root (e.g. "services/api"); "." is the root project's own files. Default: the whole repo.
exportedOnlyNoOnly functions known to be exported/public.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.8.0
    • changedInput schema / properties / file / description
      Previous value: -"Only files whose path contains this (or matches it, with * globs)."New value: +"Only files whose path contains this, matches it as a * glob, or as a regex (/…/, or a value with | ( ^ $ \\, e.g. \"services/(order|payment)\")."
    • changedInput schema / properties / services / description
      Previous value: -"Limit to these services/directories, relative to SPEC_NAV_ROOT (e.g. \"services/api\", \"packages\"). \".\" is the root project's own files. Omit to cover the whole repo — the default."New value: +"Services/directories relative to the root (e.g. \"services/api\"); \".\" is the root project's own files. Default: the whole repo."
  2. First observedv0.4.0

TDQS

A3.7/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden, and it delivers real behavioral context beyond the schema: a coverage line names files not read (syntax errors, unsupported languages, skipped), completeness is only guaranteed when stated, and inline anonymous callbacks are counted rather than listed. Pagination is also disclosed. It stops short of describing error behavior or result ordering.

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?

Dense but front-loaded: the purpose and returned fields come first, then filters, then paging and completeness caveats. Every clause carries information, though the telegraphic style takes some unpacking.

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 9-parameter, zero-required read tool with no output schema, the description covers what is returned, how filtering works, the pagination contract, and the important caveat that results may be incomplete. What remains missing is guidance on choosing this tool over its siblings.

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 high (89%) and the schema already documents glob/regex semantics, defaults, and the cursor contract. The description's filter list (services, file, name, kind, language) largely restates schema fields without adding syntax or edge-case meaning beyond what is already present.

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?

States a specific verb+resource: a function catalog for a file/directory/service, explicitly enumerated return fields (qualified name, kind, signature, line range, export status, doc summary, id). The 'without bodies' qualifier implicitly separates it from spec_nav_read_function, but it does not explicitly contrast with spec_nav_find_functions, so sibling differentiation is only partial.

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?

The description gives filter dimensions and notes paging, which implies a list/enumerate use case, but it never states when to prefer this over spec_nav_find_functions or spec_nav_map, nor any exclusion conditions. Usage is inferable but not guided.

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