Skip to content

Create "search documentation" mcp tools #1532

@ChronosSF

Description

@ChronosSF

Documentation Access & Search Tools

The igniteui-doc-mcp MCP server exposes 3 tools for accessing and searching Ignite UI documentation. All tools communicate with a backend API (DOCS_BACKEND_URL) and require a framework parameter (angular | react | blazor | webcomponents).

list_components

List available Ignite UI component docs. Filter by framework and optionally by keyword match against filename, component, toc_name, keywords, summary.

Parameter Type Required Description
framework enum One of angular, react, blazor, webcomponents
filter string Optional keyword to filter by filename, component, keywords, or summary

Endpoint: GET /api/docs?framework={fw}&filter={filter}


get_doc

Return the full markdown content of a specific Ignite UI component doc. Requires framework and doc name.

Parameter Type Required Description
framework enum One of angular, react, blazor, webcomponents
name string Doc name without .md extension (e.g. "grid-editing", "accordion")

Endpoint: GET /api/docs/{framework}/{name}
Returns a 404-safe error message suggesting list_components when doc is not found.


search_docs

Full-text search across Ignite UI docs for a specific framework. Returns top 20 results with excerpt snippets.

Parameter Type Required Description
query string Search query (supports prefix matching, e.g. "grid*")
framework enum One of angular, react, blazor, webcomponents

Endpoint: GET /api/docs/search?framework={fw}&query={sanitized}
Query is sanitized: special characters are stripped, terms are wrapped in quotes and joined with OR.


Typical Workflow

  1. search_docs — when a user asks "how do I…" or describes a feature need
  2. list_components — to browse/find docs by component name or keyword
  3. get_doc — to retrieve the full doc content once the exact name is known

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions