50 lines
4.9 KiB
Plaintext
50 lines
4.9 KiB
Plaintext
page wrnexusmcp {
|
|
seo {
|
|
title = "@wrnexus/mcp"
|
|
description = "Model Context Protocol tools for WRNexus projects."
|
|
}
|
|
|
|
view {
|
|
<div class="docs-shell">
|
|
<a href="#main" class="skip-link">Skip to content</a>
|
|
<header class="topbar">
|
|
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
|
|
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
|
|
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.8.0</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
|
|
</header>
|
|
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
|
|
<main class="portal-main docs-layout">
|
|
<article id="main" class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/mcp</span></nav><section class="doc-intro"><span class="eyebrow">Tooling · Package reference</span><h1>@wrnexus/mcp</h1><p>Model Context Protocol tools for WRNexus projects.</p><div class="doc-meta"><span>v0.8.0</span><span>Private registry</span><span>Tooling</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/mcp@0.8.0</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><p>Editor-neutral Model Context Protocol server for AI development tools.</p>
|
|
<pre data-language="bash"><code>bunx wrnexus-mcp --root=.</code></pre>
|
|
<p>It exposes current routes, components with props/events, database schema files, compiler diagnostics, runtime errors, dev-server health, framework documentation and installed packages. Files are resolved inside the configured application root and returned as bounded structured JSON.</p></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>interface McpTool {
|
|
name: string;
|
|
description: string;
|
|
inputSchema: {
|
|
type: "object";
|
|
properties?: Record<string, unknown>;
|
|
additionalProperties?: boolean;
|
|
};
|
|
}
|
|
interface McpServerOptions {
|
|
maxFiles?: number;
|
|
maxFileBytes?: number;
|
|
fetch?: typeof fetch;
|
|
devServerUrl?: string;
|
|
runtimeErrors?: () => unknown[] | Promise<unknown[]>;
|
|
}
|
|
interface McpServer {
|
|
tools(): McpTool[];
|
|
call(name: string, args?: Record<string, unknown>): Promise<unknown>;
|
|
handle(message: unknown): Promise<Record<string, unknown> | null>;
|
|
}
|
|
declare function createFrameworkMcpServer(appRoot: string, options?: McpServerOptions): McpServer;
|
|
|
|
export { type McpServer, type McpServerOptions, type McpTool, createFrameworkMcpServer };
|
|
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>Editor-neutral Model Context Protocol server for AI development tools.</h3><pre data-language="bash"><code>bunx wrnexus-mcp --root=.</code></pre></article><article class="example-card"><h3>Install @wrnexus/mcp</h3><pre data-language="sh"><code>bun add @wrnexus/mcp</code></pre></article></div></section></article>
|
|
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
|
|
</main>
|
|
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.8.0</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
|
|
</div>
|
|
}
|
|
}
|