Skip to main content
Glama
pavelpikta

lampa-mcp-server

Catalog Lampa APIs and indexes

list_catalog
Read-onlyIdempotent

Retrieve a catalog from the Lampa snapshot, filtered by topic and optional query. Use it to inspect API surfaces, events, storage keys, or components without searching or tracing symbols.

Instructions

Dump one static catalog from the Lampa snapshot per call. Not a query (search_code), not a single-symbol walk (trace_symbol), not written docs (explain_docs), and not a live CUB client (guide_cub). scope applies only to api_surface/events/storage (default all); detail=true only affects events; query filters within the chosen topic — never a repo-wide search. Example: topic=events query='player' detail=true. Empty catalog → markdown, not an error; on R2, full-tree events/storage need a prebuilt index — pass query or a narrower topic (e.g. maker, socket, flags, content_rows, favorites, mirrors) if the index is missing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoFilter the chosen catalog only (not a repo-wide search): API module, event name, storage key, component name, flag keyword, or folder (for network).
scopeNoFor api_surface, events, storage: limit the tree. Default all.
topicYesWhich catalog: api_surface | events | storage | network | settings | providers | maker | socket | activity | flags | content_rows | favorites | mirrors.
detailNoFor topic=events: include per-file listener/emitter lists. Default false.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
markdownYesHuman-readable markdown report. Always present, including empty-result cases. Does not write files.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.8.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, and non-destructive behavior. The description adds valuable context beyond those annotations: this operates on a static snapshot rather than a live client, empty results render as markdown rather than error, and full-tree events/storage may require a prebuilt index on R2. No contradiction with annotations.

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 dense but well-structured: a clear lead sentence, sibling exclusions, parameter semantics, a concrete example, and edge-case behavior. Every clause earns its place, and the most important information is front-loaded.

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?

Given the tool's four parameters, two enums, output schema, and fifteen siblings, the description covers all essential decision points: what the tool does, how it differs from alternatives, parameter interactions, empty-result behavior, and the R2 index caveat. Nothing critical is left ambiguous.

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 description coverage is 100%, so the baseline is 3. The description restates the schema's parameter constraints (scope only for api_surface/events/storage, detail only for events, query scoped to topic) and provides a small example, but it does not add substantial new meaning beyond what the schema already documents.

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 opens with a specific verb and resource: 'Dump one static catalog from the Lampa snapshot per call.' It then actively differentiates itself from four siblings (search_code, trace_symbol, explain_docs, guide_cub), so an agent can immediately tell what this tool is and is not.

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?

The description gives explicit when-not-to-use guidance by naming alternatives, and it provides conditional usage advice for R2 when the prebuilt index is missing. It also clarifies that query is a scoped filter, not a repo-wide search, which prevents misuse.

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