import { createTestRegistry, McpController, McpRegistry, Prompt, Resource, ResourceTemplate, Tool, type McpAccessPolicy, type McpContext, } from '../src'; import { createAttachHarness, type AttachHarness, type TestCtx } from './harness'; import { afterEach, describe, expect, it } from 'vitest'; import { z } from 'zod'; class Greeter { greet(name: string): string { return `hello ${name}`; } } @McpController() class FixtureMcp { constructor(private readonly greeter: Greeter) {} @Tool({ name: 'read_tool', description: 'Reads.', inputSchema: { name: z.string() }, annotations: { readOnlyHint: true }, access: { group: 'g', mode: 'read' }, }) async readTool({ name }: { name: string }, ctx: TestCtx) { return { content: [{ type: 'text', text: JSON.stringify({ greeting: this.greeter.greet(name), userId: ctx.userId }) }], }; } @Tool({ name: 'write_tool', inputSchema: {}, access: { group: 'g', mode: 'write' } }) async writeTool(_args: Record, ctx: TestCtx) { return { content: [{ type: 'text', text: `wrote as ${ctx.userId}` }] }; } @Tool({ name: 'predicate_tool', access: (ctx: McpContext) => (ctx as TestCtx).allow === true }) async predicateTool(args: Record, ctx: TestCtx) { return { content: [{ type: 'text', text: JSON.stringify({ args, userId: ctx.userId }) }] }; } @Tool({ name: 'open_tool' }) async openTool(args: Record, ctx: TestCtx) { return { content: [{ type: 'text', text: JSON.stringify({ args, userId: ctx.userId }) }] }; } @Resource({ name: 'fixture_doc', uri: 'test://doc', mimeType: 'text/plain', access: { group: 'g', mode: 'read' } }) async readDoc(uri: URL, ctx: TestCtx) { return { contents: [{ uri: uri.href, text: `doc for ${ctx.userId}` }] }; } @ResourceTemplate({ name: 'fixture_item', uriTemplate: 'test://item/{id}' }) async readItem(uri: URL, variables: { id: string }, ctx: TestCtx) { return { contents: [{ uri: uri.href, text: `item ${variables.id} for ${ctx.userId}` }] }; } @Prompt({ name: 'fixture_prompt', description: 'Prompts.', argsSchema: { topic: z.string() } }) async fixturePrompt({ topic }: { topic: string }, ctx: TestCtx) { return { messages: [{ role: 'user', content: { type: 'text', text: `${topic} for ${ctx.userId}` } }] }; } } @McpController() class DeclarativeOnly { @Tool({ name: 'gated_tool', access: { group: 'g', mode: 'read' } }) async gated() { return { content: [{ type: 'text', text: 'gated' }] }; } } @McpController() class WhenMcp { @Tool({ name: 'when_scoped_tool', access: { group: 'g', mode: 'read' }, when: (ctx: McpContext) => (ctx as TestCtx).allow === true, }) async whenScoped() { return { content: [{ type: 'text', text: 'ok' }] }; } @Tool({ name: 'when_only_tool', when: (ctx: McpContext) => (ctx as TestCtx).allow === true }) async whenOnly() { return { content: [{ type: 'text', text: 'ok' }] }; } // Ungated: keeps the tools capability advertised even when every gated // entry is filtered (an SDK server with zero tools rejects tools/list). @Tool({ name: 'probe_tool' }) async probe() { return { content: [{ type: 'text', text: 'ok' }] }; } // The gate reads the DECLARING INSTANCE rather than a module-level value. // This is the shape a host needs to answer "is this addon on" from an // injected service: the options object is built when the class is defined, // so without `self` the closure has nothing but imports to reach for. @Tool({ name: 'self_gated_tool', when: (_ctx, self: WhenMcp) => self.featureOn }) async selfGated() { return { content: [{ type: 'text', text: 'ok' }] }; } featureOn = false; } const policy: McpAccessPolicy = ({ mode }, ctx) => mode === 'write' ? (ctx as TestCtx).canWrite === true : (ctx as TestCtx).canRead === true; const buildRegistry = () => createTestRegistry([new FixtureMcp(new Greeter())], { accessPolicy: policy }); const textOf = (result: unknown): string => { const content = (result as { content: { type: string; text: string }[] }).content; const item = content.find((c) => c.type === 'text'); if (!item) throw new Error('no text content'); return item.text; }; describe('McpRegistry.attach', () => { let harness: AttachHarness | undefined; afterEach(async () => { await harness?.cleanup(); harness = undefined; }); it('registers everything for a ctx passing all access checks', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 7, canRead: true, canWrite: true, allow: true }); const tools = (await harness.client.listTools()).tools.map((t) => t.name).sort(); expect(tools).toEqual(['open_tool', 'predicate_tool', 'read_tool', 'write_tool']); const resources = (await harness.client.listResources()).resources.map((r) => r.name); expect(resources).toEqual(['fixture_doc']); const templates = (await harness.client.listResourceTemplates()).resourceTemplates.map((t) => t.name); expect(templates).toEqual(['fixture_item']); const prompts = (await harness.client.listPrompts()).prompts.map((p) => p.name); expect(prompts).toEqual(['fixture_prompt']); }); it('filters declarative access through the policy per mode', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 7, canRead: true, canWrite: false, allow: false }); const tools = (await harness.client.listTools()).tools.map((t) => t.name).sort(); expect(tools).toEqual(['open_tool', 'read_tool']); }); it('filters everything gated when the ctx grants nothing, keeping ungated entries', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 7 }); const tools = (await harness.client.listTools()).tools.map((t) => t.name).sort(); expect(tools).toEqual(['open_tool']); expect((await harness.client.listResources()).resources).toEqual([]); const templates = (await harness.client.listResourceTemplates()).resourceTemplates.map((t) => t.name); expect(templates).toEqual(['fixture_item']); }); it('exposes tool metadata (description, annotations, input schema) to the client', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 7, canRead: true, canWrite: true, allow: true }); const read = (await harness.client.listTools()).tools.find((t) => t.name === 'read_tool'); expect(read?.description).toBe('Reads.'); expect(read?.annotations).toMatchObject({ readOnlyHint: true }); expect(read?.inputSchema).toMatchObject({ type: 'object', properties: { name: { type: 'string' } } }); }); it('binds (args, ctx) and preserves `this` on tool handlers', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 42, canRead: true, canWrite: true, allow: true }); const result = await harness.client.callTool({ name: 'read_tool', arguments: { name: 'trek' } }); expect(JSON.parse(textOf(result))).toEqual({ greeting: 'hello trek', userId: 42 }); }); it('normalizes args to {} for tools declared without an inputSchema', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 42 }); const result = await harness.client.callTool({ name: 'open_tool', arguments: {} }); expect(JSON.parse(textOf(result))).toEqual({ args: {}, userId: 42 }); }); it('serves fixed resources with (uri, ctx)', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 9, canRead: true }); const result = await harness.client.readResource({ uri: 'test://doc' }); expect(result.contents[0]).toMatchObject({ uri: 'test://doc', text: 'doc for 9' }); }); it('serves resource templates with (uri, variables, ctx)', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 9 }); const result = await harness.client.readResource({ uri: 'test://item/42' }); expect(result.contents[0]).toMatchObject({ uri: 'test://item/42', text: 'item 42 for 9' }); }); it('serves prompts with (args, ctx)', async () => { harness = await createAttachHarness(buildRegistry(), { userId: 3 }); const result = await harness.client.getPrompt({ name: 'fixture_prompt', arguments: { topic: 'packing' } }); expect(result.messages[0]?.content).toMatchObject({ type: 'text', text: 'packing for 3' }); }); it('ANDs `when` in front of declarative access (both must pass)', async () => { const registry = createTestRegistry([new WhenMcp()], { accessPolicy: policy }); harness = await createAttachHarness(registry, { userId: 7, canRead: true, allow: true }); const tools = (await harness.client.listTools()).tools.map((t) => t.name).sort(); expect(tools).toEqual(['probe_tool', 'when_only_tool', 'when_scoped_tool']); }); it('hands `when` the instance that declared the entry, resolved at attach', async () => { const controller = new WhenMcp(); const registry = createTestRegistry([controller], { accessPolicy: policy }); harness = await createAttachHarness(registry, { userId: 7 }); expect((await harness.client.listTools()).tools.map((t) => t.name)).not.toContain('self_gated_tool'); await harness.cleanup(); // Flipped AFTER registration: a gate that had captured a value when the // class was defined could not see this, which is exactly why hosts reached // for a module-level singleton instead of an injected one. controller.featureOn = true; harness = await createAttachHarness(registry, { userId: 7 }); expect((await harness.client.listTools()).tools.map((t) => t.name)).toContain('self_gated_tool'); }); it('skips entries whose `when` gate fails, even when access would pass', async () => { const registry = createTestRegistry([new WhenMcp()], { accessPolicy: policy }); harness = await createAttachHarness(registry, { userId: 7, canRead: true, allow: false }); expect((await harness.client.listTools()).tools.map((t) => t.name)).toEqual(['probe_tool']); }); it('skips when-gated entries whose access fails, keeping when-only ones', async () => { const registry = createTestRegistry([new WhenMcp()], { accessPolicy: policy }); harness = await createAttachHarness(registry, { userId: 7, canRead: false, allow: true }); const tools = (await harness.client.listTools()).tools.map((t) => t.name).sort(); expect(tools).toEqual(['probe_tool', 'when_only_tool']); }); it('createTestRegistry fails fast on declarative access without an accessPolicy', () => { expect(() => createTestRegistry([new DeclarativeOnly()])).toThrow( /declare declarative access but no accessPolicy was configured/, ); }); it('attach itself still guards declarative access without a policy (defense in depth)', () => { // Bypass createTestRegistry's validate() by assembling the registry by hand. const registry = new McpRegistry(); registry.register(new DeclarativeOnly()); expect(() => registry.attach( // attach never gets far enough to need a live server here {} as Parameters[0], { userId: 1 } as McpContext, ), ).toThrow(/declares declarative access but no accessPolicy was configured/); }); });