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

lichtblick-docs-mcp

Official
by lichtblick-suite
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Search Lichtblick documentation

docs_search
Read-only

Searches official Lichtblick documentation and guides by keyword to return matching sections with page paths, URLs, and snippets; use before web search for Lichtblick questions.

Instructions

Full-text search over the official Lichtblick documentation and guides (panels, data sources, layouts, settings, extensions, custom panels, message converters). Use this BEFORE web search for any Lichtblick question. Returns matching sections with page path, URL and snippet; read the full page with docs_fetch.

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": {
      "query": "<query>"
    },
    "name": "docs_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of sections to return.
queryYesA few keywords, e.g. 'subscribe topics custom panel', 'mcap remote file', '3d panel transforms'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.0
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of sections to return."
    • changedInput schema / properties / query / description
      Previous value: -"Keywords, e.g. 'subscribe topics custom panel'."New value: +"A few keywords, e.g. 'subscribe topics custom panel', 'mcap remote file', '3d panel transforms'."
  2. First observedv0.0.0

TDQS

A4.5/5.0
Behavior4/5

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

readOnlyHint=true already declares the safety profile, and the description adds what the annotations cannot: the return shape (page path, URL, snippet) and that results are section-level rather than whole pages. It does not discuss ranking, result quality, or behavior when nothing matches, which keeps it from a 5.

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?

Three short sentences, each doing distinct work: scope, when to prefer it, and what it returns plus the next step. Scope and the routing advice are front-loaded with no filler.

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?

For a two-parameter search tool with no output schema, the definition covers what is searched, when to use it, what comes back, and how to continue. Nothing an agent needs in order to call it and act on results is missing.

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 both `query` and `limit` (including its default of 8 and 1-20 range) are already documented in structured form. The description adds no meaning beyond that – it does not explain query syntax, keyword behavior, or how multiple terms are combined.

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?

"Full-text search over the official Lichtblick documentation and guides" states a specific verb and resource, and the parenthetical enumerates the covered topic areas (panels, data sources, layouts, settings, extensions, custom panels, message converters). It is clearly distinguishable from docs_fetch, which it names as the follow-up full-page reader.

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?

"Use this BEFORE web search for any Lichtblick question" gives an explicit selection rule against a named alternative, and the final clause routes the agent onward to docs_fetch when snippets are insufficient. The entry point and hand-off of the docs workflow are both spelled out.

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