@usex/mikrotik-mcp 1.0.0 → 2.1.0

package/dist/index.d.ts

@@ -35,12 +35,40 @@ declare function executeMikrotikCommand(command: string, ctx: ToolContext): Prom
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
 import { ZodRawShape } from "zod";
+/** Links a tool to an MCP App view resource. */
+interface UiLink {
+	/** `ui://…` resource URI of the HTML view the host should render. */
+	resourceUri: string;
+	/**
+	* Where the tool may be invoked from. `"model"` lets the LLM call it;
+	* `"app"` lets the rendered view call it (e.g. polling/refresh helpers).
+	* Defaults to model-visible when omitted.
+	*/
+	visibility?: ("model" | "app")[];
+}
 /** Options threaded into every tool registration. */
 interface RegisterOptions {
 	sendLog?: SendLog;
 	/** Configured device names; when more than one, a `device` selector is injected. */
 	deviceNames?: string[];
+	/**
+	* Read-only mode: register only tools annotated `readOnlyHint`. Used to
+	* withhold every write/destructive tool from a publicly-exposed surface (e.g.
+	* a ChatGPT Apps connector) until authentication is in place.
+	*/
+	readOnly?: boolean;
 }
+/**
+* A handler may return plain text (the common case — wrapped as the model-facing
+* result) or a structured payload. `structuredContent` is the data an MCP App
+* view renders; `text` remains the fallback shown to the model and to text-only
+* hosts, so UI is always additive.
+*/
+interface ToolResult {
+	text: string;
+	structuredContent?: Record<string, unknown>;
+}
+type HandlerOutput = string | ToolResult;
 interface ToolDef<Shape extends ZodRawShape> {
 	/** Stable tool id exposed to MCP clients. */
 	name: string;
@@ -52,8 +80,14 @@ interface ToolDef<Shape extends ZodRawShape> {
 	annotations: ToolAnnotations;
 	/** Zod raw shape describing the tool's parameters. */
 	inputSchema?: Shape;
-	/** Handler returning the textual result shown to the model. */
-	handler: (args: any, ctx: ToolContext) => Promise<string> | string;
+	/**
+	* Optional MCP App view: links this tool to a `ui://…` HTML resource the host
+	* renders inline. When set, the tool should return `structuredContent` for the
+	* view (it still returns `text` for non-UI hosts).
+	*/
+	ui?: UiLink;
+	/** Handler returning the result shown to the model (text, or text + structured data). */
+	handler: (args: any, ctx: ToolContext) => Promise<HandlerOutput> | HandlerOutput;
 }
 interface RegisterableTool {
 	name: string;
@@ -61,6 +95,8 @@ interface RegisterableTool {
 	annotations: ToolAnnotations;
 	inputSchema?: ZodRawShape;
 	description: string;
+	/** Present when the tool renders an MCP App view. */
+	ui?: UiLink;
 	register: (server: McpServer, opts?: RegisterOptions) => void;
 }
 declare function defineTool<Shape extends ZodRawShape>(def: ToolDef<Shape>): RegisterableTool;
@@ -86,6 +122,10 @@ interface CreatedServer {
 	server: McpServer2;
 	toolCount: number;
 	promptCount: number;
+	/** Number of MCP App `ui://` views registered as resources. */
+	uiViewCount: number;
+	/** True when only read-only tools were registered. */
+	readOnly: boolean;
 }
 declare function createServer(opts?: {
 	sendLog?: SendLog;