mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-02-07 05:53:07 +00:00
23b90d01a6
* feat: add MCP Apps with rich HTML UIs for tool results Add MCP Apps infrastructure that allows MCP hosts like Claude Desktop to render rich HTML UIs alongside tool results via `_meta.ui` and the MCP resources protocol. - Server-side UI module (src/mcp/ui/) with UIAppRegistry, tool-to-UI mapping, and _meta.ui injection into tool responses - React + Vite build pipeline (ui-apps/) producing self-contained HTML per app using vite-plugin-singlefile - Operation Result UI for workflow CRUD tools (create, update, delete, test, autofix, deploy) - Validation Summary UI for validation tools (validate_node, validate_workflow, n8n_validate_workflow) - Shared component library (Card, Badge, Expandable) with n8n dark theme - MCP resources protocol support (ListResources, ReadResource handlers) - Graceful degradation when ui-apps/dist/ is not built - 22 unit tests across 3 test files Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * test: improve MCP Apps test coverage and add security hardening - Expand test suite from 22 to 57 tests across 3 test files - Add UIAppRegistry.reset() for proper test isolation between tests - Replace some fs mocks with real temp directory tests in registry - Add edge case coverage: empty strings, pre-load state, double load, malformed URIs, duplicate tool patterns, empty HTML files - Add regression tests for specific tool-to-UI mappings - Add URI format consistency validation across all configs - Improve _meta.ui injection tests with structuredContent coexistence - Coverage: statements 79.4% -> 80%, lines 79.4% -> 80% Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: align MCP Apps with official ext-apps spec Update URI scheme from n8n-mcp://ui/ to ui://n8n-mcp/ per MCP spec. Move _meta.ui.resourceUri to tool definitions (tools/list) instead of tool call responses. Rewrite UI apps hook to use @modelcontextprotocol/ext-apps App class instead of window.__MCP_DATA__. Conceived by Romuald Czlonkowski - https://www.aiadvisors.pl/en Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
146 lines
4.7 KiB
TypeScript
146 lines
4.7 KiB
TypeScript
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
|
import { UIAppRegistry } from '@/mcp/ui/registry';
|
|
|
|
vi.mock('fs', () => ({
|
|
existsSync: vi.fn(),
|
|
readFileSync: vi.fn(),
|
|
}));
|
|
|
|
import { existsSync, readFileSync } from 'fs';
|
|
|
|
const mockExistsSync = vi.mocked(existsSync);
|
|
const mockReadFileSync = vi.mocked(readFileSync);
|
|
|
|
describe('UI Meta Injection on Tool Definitions', () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
UIAppRegistry.reset();
|
|
});
|
|
|
|
describe('when HTML is loaded', () => {
|
|
beforeEach(() => {
|
|
mockExistsSync.mockReturnValue(true);
|
|
mockReadFileSync.mockReturnValue('<html>ui content</html>');
|
|
UIAppRegistry.load();
|
|
});
|
|
|
|
it('should add _meta.ui.resourceUri to matching tool definitions', () => {
|
|
const tools: any[] = [
|
|
{ name: 'n8n_create_workflow', description: 'Create workflow', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeDefined();
|
|
expect(tools[0]._meta.ui.resourceUri).toBe('ui://n8n-mcp/operation-result');
|
|
});
|
|
|
|
it('should add _meta.ui.resourceUri to validation tool definitions', () => {
|
|
const tools: any[] = [
|
|
{ name: 'validate_workflow', description: 'Validate', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeDefined();
|
|
expect(tools[0]._meta.ui.resourceUri).toBe('ui://n8n-mcp/validation-summary');
|
|
});
|
|
|
|
it('should NOT add _meta to non-matching tool definitions', () => {
|
|
const tools: any[] = [
|
|
{ name: 'get_node_info', description: 'Get info', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeUndefined();
|
|
});
|
|
|
|
it('should inject _meta on matching tools and skip non-matching in a mixed list', () => {
|
|
const tools: any[] = [
|
|
{ name: 'n8n_create_workflow', description: 'Create', inputSchema: { type: 'object', properties: {} } },
|
|
{ name: 'get_node_info', description: 'Info', inputSchema: { type: 'object', properties: {} } },
|
|
{ name: 'validate_node', description: 'Validate', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeDefined();
|
|
expect(tools[0]._meta.ui.resourceUri).toBe('ui://n8n-mcp/operation-result');
|
|
expect(tools[1]._meta).toBeUndefined();
|
|
expect(tools[2]._meta).toBeDefined();
|
|
expect(tools[2]._meta.ui.resourceUri).toBe('ui://n8n-mcp/validation-summary');
|
|
});
|
|
|
|
it('should produce _meta with exact shape { ui: { resourceUri: string } }', () => {
|
|
const tools: any[] = [
|
|
{ name: 'n8n_create_workflow', description: 'Create', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toEqual({
|
|
ui: {
|
|
resourceUri: 'ui://n8n-mcp/operation-result',
|
|
},
|
|
});
|
|
expect(Object.keys(tools[0]._meta)).toEqual(['ui']);
|
|
expect(Object.keys(tools[0]._meta.ui)).toEqual(['resourceUri']);
|
|
expect(typeof tools[0]._meta.ui.resourceUri).toBe('string');
|
|
});
|
|
});
|
|
|
|
describe('when HTML is not loaded', () => {
|
|
beforeEach(() => {
|
|
mockExistsSync.mockReturnValue(false);
|
|
UIAppRegistry.load();
|
|
});
|
|
|
|
it('should NOT add _meta even for matching tools', () => {
|
|
const tools: any[] = [
|
|
{ name: 'n8n_create_workflow', description: 'Create', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeUndefined();
|
|
});
|
|
|
|
it('should NOT add _meta for validation tools without HTML', () => {
|
|
const tools: any[] = [
|
|
{ name: 'validate_node', description: 'Validate', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe('when registry has not been loaded at all', () => {
|
|
it('should NOT add _meta because registry is not loaded', () => {
|
|
const tools: any[] = [
|
|
{ name: 'n8n_create_workflow', description: 'Create', inputSchema: { type: 'object', properties: {} } },
|
|
];
|
|
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
|
|
expect(tools[0]._meta).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe('empty tool list', () => {
|
|
beforeEach(() => {
|
|
mockExistsSync.mockReturnValue(true);
|
|
mockReadFileSync.mockReturnValue('<html>ui</html>');
|
|
UIAppRegistry.load();
|
|
});
|
|
|
|
it('should handle an empty tools array without error', () => {
|
|
const tools: any[] = [];
|
|
UIAppRegistry.injectToolMeta(tools);
|
|
expect(tools.length).toBe(0);
|
|
});
|
|
});
|
|
});
|