@polyxd/mcp 0.4.2 → 0.4.3

package/README.md

@@ -50,6 +50,7 @@ From a clone of this repository: `npm install && npm run build -w @polyxd/mcp`,
 | `polyxd_show` | Validates, then returns the document for display. `pack` picks the design-system pack (default `material3`), `mode` picks light or dark (default: the host's theme). Shows nothing when there are errors. | `{ shown: true, document, pack, packName, mode?, specVersion }`, or `{ shown: false, issues }` with `isError` |
 | `polyxd_packs` | The packs: published design systems and original templates. | `{ default, packs[{ name, displayName, template, package, description }] }` |
 | `polyxd_components` | The components with a one-line summary each, or one component's full definition by `name`. | `{ components[{ name, category, summary, shell }] }`, or `{ component }` with the full definition |
+| `polyxd_docs` | Searches the polyxd.com docs bundled into this version: the sections that best match `query`, one whole `page`, or the list of pages. | `{ sections[{ page, title, heading, url, text }] }`, `{ page }` or `{ pages[] }` |
 
 Every tool is read-only. `data` can be passed to `polyxd_validate`, `polyxd_verify` and `polyxd_show` separately from the document; it replaces the document's own `data`.
 

package/dist/docs.d.ts

@@ -0,0 +1,32 @@
+/**
+ * polyxd_docs: the polyxd.com docs, bundled into the package (scripts/sync.ts writes
+ * docs.generated.ts), so answers match the released version and work offline.
+ *
+ * Search is plain keyword scoring over the docs' sections (each "## " heading and what follows),
+ * with a section's heading and its page's title counting more than its body. Small and
+ * predictable; the docs are a couple of hundred sections.
+ */
+import { DOCS, type DocPage } from "./docs.generated.ts";
+export { DOCS, type DocPage };
+export interface DocSection {
+    page: string;
+    title: string;
+    heading: string;
+    url: string;
+    text: string;
+}
+/** How much a search answer may carry, so one call stays a reasonable part of a context window. */
+export declare const SEARCH_LIMIT_CHARS = 12000;
+export declare const PAGE_LIMIT_CHARS = 40000;
+/**
+ * A heading's anchor on polyxd.com. The site slugifies the heading as marked renders it
+ * (apps/site/scripts/build.ts), so this renders the inline Markdown the same way first: links to
+ * their text, code and emphasis marks dropped, and marked's escapes (an apostrophe is ').
+ */
+export declare const anchorFor: (heading: string) => string;
+/** Every section of every page. A page's text before its first "## " is a section headed by the page's title. */
+export declare function sections(): DocSection[];
+/** The sections that best match the question, best first, within {@link SEARCH_LIMIT_CHARS}. */
+export declare function searchDocs(query: string, limit?: number): DocSection[];
+/** A page by its slug, title or URL: "quickstart", "Quickstart", "https://polyxd.com/docs/quickstart/". */
+export declare function docPage(name: string): DocPage | undefined;

package/dist/docs.generated.d.ts

@@ -0,0 +1,13 @@
+export interface DocPage {
+    /** The page's path under /docs/: "" for the docs home, "quickstart", … */
+    slug: string;
+    title: string;
+    description: string;
+    section: string;
+    order: number;
+    /** The page on polyxd.com. */
+    url: string;
+    /** The page's Markdown, without its title, with site links made absolute. */
+    markdown: string;
+}
+export declare const DOCS: DocPage[];