server-helpers | MCP Apps
https://apps.extensions.modelcontextprotocol.io/api/modules/server-helpers.html • 25 KB fetched Open original page
server-helpers | MCP Apps
MCP Apps GitHub Specification
Preparing search index...
* server-helpers
Module server-helpers
Utilities for MCP servers to register tools and resources that display interactive UIs.
Use these helpers instead of the base SDK's registerTool and registerResource when
your tool should render an App in the client. They handle UI metadata normalization
and provide sensible defaults for the MCP Apps MIME type ( RESOURCE_MIME_TYPE ).
Example
// Register a tool that displays a view
registerAppTool (
server ,
"weather" ,
{
description: "Get weather forecast" ,
_meta: { ui: { resourceUri: "ui://weather/view.html" } },
},
toolCallback ,
);
// Register the HTML resource the tool references
registerAppResource (
server ,
"Weather View" ,
"ui://weather/view.html" ,
{},
readCallback ,
);
Copy
Functions
getUiCapability registerAppResource registerAppTool Interfaces
McpUiAppResourceConfig McpUiAppToolConfig ToolConfig Type Aliases
LegacyToolCallback McpUiReadResourceCallback McpUiReadResourceResult ReadResourceCallback ResourceMetadata ToolCallback ZodRawShape Variables
EXTENSION_ID RESOURCE_MIME_TYPE RESOURCE_URI_META_KEY
Settings
Member Visibility
* Protected
* Inherited
* External
Theme OS Light Dark
On This Page
Functions get Ui Capability register App Resource register App Tool
Interfaces Mcp Ui App Resource Config Mcp Ui App Tool Config Tool Config
Type Aliases Legacy Tool Callback Mcp Ui Read Resource Callback Mcp Ui Read Resource Result Read Resource Callback Resource Metadata Tool Callback Zod Raw Shape
Variables EXTENSION_ ID RESOURCE_ MIME_ TYPE RESOURCE_ URI_ META_ KEY
GitHub Specification MCP Apps
* Loading...
Generated using TypeDoc with typedoc-github-theme
Links found on this page
- MCP Apps [direct]
- GitHub [direct]
- Specification [direct]
- server-helpers [direct]
- App [direct]
- RESOURCE_MIME_TYPE [direct]
- getUiCapability [direct]
- registerAppResource [direct]
- registerAppTool [direct]
- McpUiAppResourceConfig [direct]
- McpUiAppToolConfig [direct]
- ToolConfig [direct]
- LegacyToolCallback [direct]
- McpUiReadResourceCallback [direct]
- McpUiReadResourceResult [direct]
- ReadResourceCallback [direct]
- ResourceMetadata [direct]
- ToolCallback [direct]
- ZodRawShape [direct]
- EXTENSION_ID [direct]
- RESOURCE_URI_META_KEY [direct]
- MCP Apps [direct]
- TypeDoc [direct]
- typedoc-github-theme [direct]
|
|