Skip to main content
Glama
Sign In
lichtblick-docs-mcp

lichtblick-docs-mcp

Official
by lichtblick-suite
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Get a @lichtblick/suite API symbol

extension_api_get
Read-only

Returns exact TypeScript declaration and doc comments for an @lichtblick/suite symbol, enabling correct Lichtblick extension or panel code without relying on memory.

Instructions

Returns the exact TypeScript declaration and doc comments of a symbol exported by @lichtblick/suite, e.g. PanelExtensionContext, ExtensionContext, RenderState, SettingsTreeNode, MessageEvent. Always use it instead of memory when writing Lichtblick extension or panel code: the API differs from Foxglove Studio's.

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": {
      "symbol": "<symbol>"
    },
    "name": "extension_api_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
symbolYesExported symbol name (case-insensitive).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare this is a read-only operation, so the description correctly spends its space on the return contract (exact declaration plus doc comments) and on the non-obvious warning that the API diverges from Foxglove Studio's. It does not say what happens for an unknown symbol, e.g. an error versus a suggestion list.

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?

Two sentences, both earning their place: the return contract first, then the directive plus its rationale. Nothing is repeated from the title or schema, and the most actionable statement is front-loaded.

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?

With no output schema, the description carries the return-value burden and does so by naming the exact artifacts returned. For a one-parameter lookup tool this is nearly complete, missing only error or fallback behavior for unmatched symbol names.

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 100% and the single parameter already documents itself as a case-insensitive exported symbol name. The description adds no format or matching nuance beyond the schema, so the baseline 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?

States a specific verb and resource ("Returns the exact TypeScript declaration and doc comments of a symbol exported by @lichtblick/suite") and reinforces it with concrete example symbols like PanelExtensionContext and SettingsTreeNode. The only gap is that it never distinguishes itself from the sibling extension_api_list, which an agent would plausibly confuse with a symbol lookup.

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

Usage Guidelines4/5

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

Gives a clear usage directive backed by a reason: "Always use it instead of memory when writing Lichtblick extension or panel code: the API differs from Foxglove Studio's." That tells the agent when to reach for it, but there is no when-not condition and no named alternative such as extension_api_list for discovering symbol names.

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

Deploy Server

Other Tools