Skip to main content
Glama

Search RevoGrid Docs

search_revogrid_docs
Read-onlyIdempotent

Use for broad RevoGrid questions or when the exact API name is unknown. Searches source-grounded docs and API evidence; defaults to public exports.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum results per page.
queryYesRevoGrid concept, API symbol, package, or implementation question.
cursorNoOpaque cursor returned by the previous page.
productNoRestrict results to one RevoGrid product.
surfaceNoLegacy catalog surface filter.
versionNoRestrict results to an indexed package version.
docTypesNoRestrict source kinds such as API, guide, or example.
frameworkNoRestrict results to a consumer framework.
symbolKindNoRestrict exported declaration kind.
visibilityNoDefaults to public; internal requires explicit internal selection.
packageNameNoExact published npm package name.
requiresProNoFilter by descriptive Pro/license requirement.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
resultsYes
nextCursorNo
appliedFiltersYes
suggestedNextToolNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed15 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Opaque cursor returned by the previous page.",
      +  "type": "string"
      +}
    • addedInput schema / properties / docTypes / description
      Added value: +"Restrict source kinds such as API, guide, or example."
    • addedInput schema / properties / framework / description
      Added value: +"Restrict results to a consumer framework."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum results per page."
    • addedInput schema / properties / packageName
      Added value: +{
      +  "description": "Exact published npm package name.",
      +  "type": "string"
      +}
    • addedInput schema / properties / product
      Added value: +{
      +  "description": "Restrict results to one RevoGrid product.",
      +  "enum": [
      +    "core",
      +    "pro",
      +    "pivot",
      +    "gantt",
      +    "scheduler",
      +    "kanban",
      +    "collaboration",
      +    "enterprise"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / query / description
      Added value: +"RevoGrid concept, API symbol, package, or implementation question."
    • addedInput schema / properties / requiresPro / description
      Added value: +"Filter by descriptive Pro/license requirement."
    • addedInput schema / properties / surface / description
      Added value: +"Legacy catalog surface filter."
    • addedInput schema / properties / symbolKind
      Added value: +{
      +  "description": "Restrict exported declaration kind.",
      +  "enum": [
      +    "class",
      +    "function",
      +    "interface",
      +    "type",
      +    "enum",
      +    "variable",
      +    "event",
      +    "plugin",
      +    "component",
      +    "unknown"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / version / description
      Added value: +"Restrict results to an indexed package version."
    • addedInput schema / properties / visibility
      Added value: +{
      +  "description": "Defaults to public; internal requires explicit internal selection.",
      +  "enum": [
      +    "public",
      +    "internal"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": false,
      +  "properties": {
      +    "appliedFilters": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "cursor": {
      +          "type": "string"
      +        },
      +        "docTypes": {
      +          "items": {
      +            "enum": [
      +              "guide",
      +              "api",
      +              "example",
      +              "live-demo",
      +              "migration",
      +              "faq"
      +            ],
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "framework": {
      +          "enum": [
      +            "react",
      +            "vue",
      +            "angular",
      +            "svelte",
      +            "vanilla"
      +          ],
      +          "type": "string"
      +        },
      +        "limit": {
      +          "maximum": 20,
      +          "minimum": 1,
      +          "type": "integer"
      +        },
      +        "packageName": {
      +          "type": "string"
      +        },
      +        "product": {
      +          "enum": [
      +            "core",
      +            "pro",
      +            "pivot",
      +            "gantt",
      +            "scheduler",
      +            "kanban",
      +            "collaboration",
      +            "enterprise"
      +          ],
      +          "type": "string"
      +        },
      +        "requiresPro": {
      +          "type": "boolean"
      +        },
      +        "surface": {
      +          "enum": [
      +            "core",
      +            "pro",
      +            "pivot",
      +            "plugin",
      +            "columntype",
      +            "migration",
      +            "changelog",
      +            "internal"
      +          ],
      +          "type": "string"
      +        },
      +        "symbolKind": {
      +          "enum": [
      +            "class",
      +            "function",
      +            "interface",
      +            "type",
      +            "enum",
      +            "variable",
      +            "event",
      +            "plugin",
      +            "component",
      +            "unknown"
      +          ],
      +          "type": "string"
      +        },
      +        "version": {
      +          "type": "string"
      +        },
      +        "visibility": {
      +          "enum": [
      +            "public",
      +            "internal"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "limit"
      +      ],
      +      "type": "object"
      +    },
      +    "nextCursor": {
      +      "type": "string"
      +    },
      +    "query": {
      +      "type": "string"
      +    },
      +    "results": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "authority": {
      +            "type": "number"
      +          },
      +          "docType": {
      +            "enum": [
      +              "guide",
      +              "api",
      +              "example",
      +              "live-demo",
      +              "migration",
      +              "faq"
      +            ],
      +            "type": "string"
      +          },
      +          "exampleUrl": {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          "framework": {
      +            "enum": [
      +              "react",
      +              "vue",
      +              "angular",
      +              "svelte",
      +              "vanilla"
      +            ],
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "packageName": {
      +            "type": "string"
      +          },
      +          "packageVersion": {
      +            "type": "string"
      +          },
      +          "product": {
      +            "enum": [
      +              "core",
      +              "pro",
      +              "pivot",
      +              "gantt",
      +              "scheduler",
      +              "kanban",
      +              "collaboration",
      +              "enterprise"
      +            ],
      +            "type": "string"
      +          },
      +          "requiresPro": {
      +            "type": "boolean"
      +          },
      +          "score": {
      +            "type": "number"
      +          },
      +          "snippet": {
      +            "type": "string"
      +          },
      +          "sourcePath": {
      +            "type": "string"
      +          },
      +          "sourceRevision": {
      +            "type": "string"
      +          },
      +          "summary": {
      +            "type": "string"
      +          },
      +          "surface": {
      +            "enum": [
      +              "core",
      +              "pro",
      +              "pivot",
      +              "plugin",
      +              "columntype",
      +              "migration",
      +              "changelog",
      +              "internal"
      +            ],
      +            "type": "string"
      +          },
      +          "symbolKind": {
      +            "enum": [
      +              "class",
      +              "function",
      +              "interface",
      +              "type",
      +              "enum",
      +              "variable",
      +              "event",
      +              "plugin",
      +              "component",
      +              "unknown"
      +            ],
      +            "type": "string"
      +          },
      +          "symbols": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "url": {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          "version": {
      +            "type": "string"
      +          },
      +          "visibility": {
      +            "enum": [
      +              "public",
      +              "internal"
      +            ],
      +            "type": "string"
      +          },
      +          "whyMatched": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "title",
      +          "summary",
      +          "surface",
      +          "docType",
      +          "requiresPro",
      +          "symbols",
      +          "score",
      +          "snippet",
      +          "url"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "suggestedNextTool": {
      +      "enum": [
      +        "search_revogrid_docs",
      +        "find_examples",
      +        "resolve_feature_matrix",
      +        "get_migration_notes",
      +        "inspect_revogrid_api",
      +        "plan_revogrid_implementation"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "appliedFilters",
      +    "results"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedInput schema / properties / surface / enum
      Previous value: -[
      -  "core",
      -  "pro",
      -  "pivot",
      -  "plugin",
      -  "columntype",
      -  "migration",
      -  "changelog"
      -]New value: +[
      +  "core",
      +  "pro",
      +  "pivot",
      +  "plugin",
      +  "columntype",
      +  "migration",
      +  "changelog",
      +  "internal"
      +]
  3. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds useful context beyond annotations: results are 'source-grounded' and visibility 'defaults to public exports.' This clarifies what the search operates over and the default access scope, which helps an agent interpret results correctly.

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 concise sentences with no filler. The primary use condition is front-loaded, and the search scope is stated efficiently. Every word contributes to agent understanding.

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 12-parameter search tool with full schema descriptions and an output schema, the description is sufficient for tool selection. It could briefly mention pagination or result structure, but the structured schema and annotations already cover most operational details. The main gap is not explicitly distinguishing from search siblings, but the usage condition handles that reasonably.

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 all 12 parameters are already documented with meaningful descriptions. The tool description does not need to repeat them, but it also adds no extra parameter-level semantics beyond the schema. Baseline 3 is appropriate because the schema carries the full burden.

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?

States a specific verb ('search') and resource ('source-grounded docs and API evidence'), and explicitly frames its use case as broad RevoGrid questions or unknown exact API names. This clearly distinguishes it from sibling tools like inspect_revogrid_api without needing to open the schema.

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?

The description gives a clear context for use: broad questions or when the exact API name is unknown. It does not explicitly name the alternative for exact API lookups, but the stated condition implies that a more targeted sibling tool should be used when the exact API is known. It could be improved by naming inspect_revogrid_api directly.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4/5.0
Disambiguation4/5

Each tool targets a distinct stage in the RevoGrid workflow: capability discovery, exact API inspection, broad documentation search, feature-matrix lookup, examples, migration notes, planning, and validation. The discovery-oriented tools overlap somewhat in surface area, but their descriptions clearly separate broad search, exact symbol resolution, and feature-existence checks.

Naming Consistency5/5

All eight tool names follow a consistent lowercase snake_case verb_noun pattern, such as find_examples, list_revogrid_capabilities, and validate_revogrid_usage. While some names omit the 'revogrid' prefix, the imperative verb + object structure is predictable and uniform.

Tool Count5/5

Eight tools is a well-scoped size for a RevoGrid implementation assistant. Each tool maps to a distinct need from discovery through planning and validation, with no redundant or filler tools.

Completeness5/5

The server covers the full advisory lifecycle: discover capabilities, search documentation, resolve feature existence, inspect exact APIs, find examples, plan implementations, validate usage, and check migration notes. There are no obvious gaps or dead ends for the stated RevoGrid-focused purpose.