Skip to main content
Glama

nucleo-docs-search

Read-onlyIdempotent

Finds reference topics and block manifests by keywords, returning ranked matches by title and excerpt. Use it when you know a concept or term but not the exact topic or block name.

Instructions

Searches the reference topics (nucleo/catalog-get with topic) and the block manifests by terms, and returns the best matches ranked by term matches: topic or block, title and excerpt. Use it when the topic or block name is unknown.

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": "nucleo-docs-search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYesTerms to search, for example "contrast token".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds value beyond them by disclosing that results are ranked by term matches and enumerating the result fields (topic or block, title, excerpt), which the annotations cannot convey; it stops short of noting corpus size or how the limit truncates ranked results.

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?

Two sentences, both earning their place, with the search scope and return shape front-loaded before the usage condition. The middle clause "ranked by term matches: topic or block, title and excerpt" is slightly compressed and reads a bit ambiguously, but nothing is padded.

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 two-parameter read-only search with no output schema, the definition covers what is searched, how results are ordered, and which fields are returned. The only meaningful omission is the limit parameter's effect on result count, which leaves the definition just short of fully self-sufficient.

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 50%: the query parameter is documented in the schema and the description reinforces it with "by terms" and "ranked by term matches", implying multi-term input. The limit parameter has no description anywhere and the definition does not say how it caps ranked results, so the gap is only partly compensated.

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?

The description gives a specific verb (searches) and names both corpora it covers: reference topics retrieved via nucleo/catalog-get with a topic, and block manifests. It also states the returned fields (topic or block, title, excerpt) and ranking basis, so an agent knows exactly what comes back, though the distinction from nucleo-catalog-list is only implied rather than stated.

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?

"Use it when the topic or block name is unknown" is an explicit when-to-use condition that cleanly separates discovery from lookup via nucleo/catalog-get. There is no explicit when-not clause or named alternative for the known-name case, which keeps it short of a 5.

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