| name | effect-mcp-server |
| description | Build MCP (Model Context Protocol) servers with Effect using McpServer, McpSchema, Tool, and Toolkit. Use this skill when implementing MCP servers that expose tools, resources, and prompts to LLM clients via stdio or HTTP transports. |
You are an Effect TypeScript expert specializing in building MCP (Model Context Protocol) servers using Effect's built-in MCP module.
Effect Source Reference
The Effect v4 source is available at ~/.cache/effect-v4/.
Browse and read files there directly to look up APIs, types, and implementations.
Reference these files:
packages/effect/MCP.md — primary MCP guide with full examples
packages/effect/src/unstable/ai/McpServer.ts — server implementation and API
packages/effect/src/unstable/ai/McpSchema.ts — schema types, param helper, error classes
What is MCP
Model Context Protocol (MCP) is a standard protocol for LLM tool integration. It allows AI clients (Claude, etc.) to discover and invoke tools, read resources, and use prompt templates exposed by a server. Effect provides a first-class MCP server implementation built on its Layer and Schema systems.
Core Imports
import { Context, Effect, Layer, Logger } from 'effect';
import { Schema } from 'effect';
import { McpServer, McpSchema, Tool, Toolkit } from 'effect/unstable/ai';
For platform-specific transports:
import { NodeRuntime, NodeSink, NodeStream } from '@effect/platform-node';
import { NodeRuntime, NodeStdio } from '@effect/platform-node';
Architecture Overview
An MCP server is composed of three kinds of part layers merged together, then provided with a transport layer:
Layer.mergeAll(
...resources, // McpServer.resource(...)
...prompts, // McpServer.prompt(...)
toolkitLayer // McpServer.toolkit(...) with implementations
).pipe(
Layer.provide(transportLayer), // McpServer.layerStdio(...) or McpServer.layerHttp(...)
Layer.provide(loggingLayer) // Logger — stderr for stdio transport
)
Each part layer has type Layer.Layer<never, never, ...> — they register themselves with the McpServer service and produce no output type.
Tools and Toolkit
Defining Tools
Tools are defined with Tool.make specifying a name, description, parameter schemas, and success schema:
const GreetTool = Tool.make('GreetTool', {
description: 'Generate a greeting message',
parameters: {
name: Schema.String,
style: Schema.Union([
Schema.Literal('formal'),
Schema.Literal('casual')
])
},
success: Schema.String
});
const CalculatorTool = Tool.make('CalculatorTool', {
description: 'Perform basic arithmetic',
parameters: {
operation: Schema.Union([
Schema.Literal('add'),
Schema.Literal('subtract'),
Schema.Literal('multiply'),
Schema.Literal('divide')
]),
a: Schema.Number,
b: Schema.Number
},
success: Schema.Number
});
Creating a Toolkit
Group tools into a Toolkit:
const MyToolkit = Toolkit.make(GreetTool, CalculatorTool);
Registering with McpServer
McpServer.toolkit(toolkit) creates a layer that registers the toolkit. Implementations are provided via Toolkit.toLayer:
const ToolkitLayer = McpServer.toolkit(MyToolkit).pipe(
Layer.provideMerge(
MyToolkit.toLayer({
GreetTool: ({ name, style }) => {
const greeting =
style === 'formal' ? `Good day, ${name}.` : `Hey ${name}!`;
return Effect.succeed(greeting);
},
CalculatorTool: ({ operation, a, b }) => {
switch (operation) {
case 'add':
return Effect.succeed(a + b);
case 'subtract':
return Effect.succeed(a - b);
case 'multiply':
return Effect.succeed(a * b);
case 'divide':
return Effect.succeed(a / b);
}
}
})
)
);
The pattern is always: McpServer.toolkit(tk).pipe(Layer.provideMerge(tk.toLayer({...}))).
MCP Tool Annotations
Effect tool annotations are emitted as MCP tool hints:
Tool.Readonly → readOnlyHint, default false
Tool.Destructive → destructiveHint, default true
Tool.Idempotent → idempotentHint, default false
Tool.OpenWorld → openWorldHint, default true
These hints help clients decide how to present tools, but they are not authorization decisions. Always enforce access control in your server handlers.
Resources
Static Resources
Expose a fixed URI resource:
const ReadmeResource = McpServer.resource({
uri: 'file:///README.md',
name: 'README',
description: 'Project README file',
mimeType: 'text/markdown',
content: Effect.succeed('# My Project\n\nProject documentation.')
});
The content field is an Effect that can produce a string, Uint8Array, or a ReadResourceResult.
Parameterized Resource Templates
Use tagged template literals with McpSchema.param for dynamic URIs:
const idParam = McpSchema.param('id', Schema.NumberFromString);
const UserResource = McpServer.resource`file://users/${idParam}.json`({
name: 'User Data',
description: 'User information by ID',
completion: {
id: (_input: string) => Effect.succeed([1, 2, 3, 4, 5])
},
content: Effect.fn(function* (_uri, id) {
return JSON.stringify({ id, name: `User ${id}` }, null, 2);
}),
mimeType: 'application/json'
});
Key points:
McpSchema.param(name, schema) creates a named URI parameter with automatic codec (e.g. Schema.NumberFromString for path segments)
completion provides auto-completion values for each parameter
content receives (uri, ...params) — the full URI string followed by decoded parameter values
audience can be ["assistant"], ["user"], or ["assistant", "user"]
Prompts
Define reusable prompt templates:
const AnalysisPrompt = McpServer.prompt({
name: 'Analyze Data',
description: 'Analyze data and provide insights',
parameters: {
dataType: Schema.String,
focus: Schema.Union([
Schema.Literal('summary'),
Schema.Literal('details')
])
},
completion: {
dataType: () => Effect.succeed(['sales', 'users', 'metrics']),
focus: () => Effect.succeed(['summary', 'details'])
},
content: ({ dataType, focus }) =>
Effect.succeed(
`Please analyze the ${dataType} data and provide a ${focus} analysis.`
)
});
parameters uses Schema.Struct.Fields (same as Schema.Struct field definitions)
completion provides auto-complete values per parameter
content receives the decoded parameters and returns Effect<string | Array<PromptMessage>>
Elicitation
Request structured input from the user at runtime:
const result = McpServer.elicit({
message: `Please answer ("yes" | "no"):`,
schema: Schema.Struct({
answer: Schema.Union([Schema.Literal('yes'), Schema.Literal('no')])
})
}).pipe(
Effect.catchTag('ElicitationDeclined', () =>
Effect.succeed({ answer: 'no' as const })
)
);
- Returns
Effect<S["Type"], ElicitationDeclined, McpServerClient>
- Handle
ElicitationDeclined with catchTag for fallback behavior
- If the user cancels, the effect is interrupted
Transport Layers
stdio Transport
For CLI-based MCP servers (most common — used by Claude Desktop, etc.):
Layer.mergeAll().pipe(
Layer.provide(
McpServer.layerStdio({ name: 'My Server', version: '1.0.0' })
),
Layer.provide(NodeStdio.layer),
Layer.provide(Layer.succeed(Logger.LogToStderr)(true))
);
Critical: When using stdio transport, logs MUST go to stderr. Any stdout output interferes with protocol communication. Use Logger.consolePretty({ stderr: true }) or Logger.LogToStderr.
HTTP Transport
For web-based MCP servers with SSE:
McpServer.layerHttp({
name: 'My MCP Server',
version: '1.0.0',
path: '/mcp'
});
- Requires
HttpRouter.HttpRouter in the context
- Uses JSON-RPC serialization (not NDJSON like stdio)
- The
path parameter sets the HTTP endpoint path
- Non-
initialize HTTP requests without a valid Mcp-Session-Id intentionally return 404; clients must keep and resend the session id from initialization.
Type signatures
layerStdio: (options: {
name: string;
version: string;
extensions?: Record<`${string}/${string}`, unknown>;
}) => Layer.Layer<McpServer | McpServerClient, never, Stdio>;
layerHttp: (options: {
name: string;
version: string;
path: HttpRouter.PathInput;
extensions?: Record<`${string}/${string}`, unknown>;
}) => Layer.Layer<McpServer | McpServerClient, never, HttpRouter.HttpRouter>;
Client Capabilities
Access the connecting client's capabilities from within tool/resource handlers:
const caps = yield* McpServer.clientCapabilities;
Conditional Tool/Resource/Prompt Enabling
Use McpSchema.EnabledWhen to conditionally list prompts, resources, resource templates, or tools based on initialized client data. The filter runs against the client initialization payload.
import { Context, Effect, Layer } from 'effect';
import { Schema } from 'effect';
import { McpSchema, McpServer, Tool } from 'effect/unstable/ai';
const requiresRoots = Context.make(
McpSchema.EnabledWhen,
(client) => client.capabilities.roots !== undefined
);
const ReadWorkspace = Tool.make('ReadWorkspace', {
description: 'Read workspace roots when the client supports roots',
success: Schema.String
}).annotateMerge(requiresRoots);
const WorkspacePrompt = McpServer.prompt({
name: 'Workspace Summary',
description: 'Summarize workspace roots',
annotations: requiresRoots,
content: () => Effect.succeed('Summarize the available workspace roots.')
});
const WorkspaceResource = Layer.effectDiscard(
McpServer.registerResource({
uri: 'workspace://roots',
name: 'Workspace Roots',
annotations: requiresRoots,
content: Effect.succeed('[]')
})
);
Relationship to OpenAI MCP Tools
McpServer exposes a server that MCP clients connect to over stdio or HTTP. OpenAiTool.Mcp is different: it is an OpenAI provider-defined tool that lets an OpenAI model call a remote MCP server. When using OpenAI's hosted MCP integration, use the canonical OpenAiMcp custom name from OpenAiTool.Mcp and handle provider approval flow through normal tool approval request/response parts.
Complete Example — stdio Server
import { NodeRuntime, NodeStdio } from '@effect/platform-node';
import { Effect, Layer, Logger } from 'effect';
import { Schema } from 'effect';
import { McpSchema, McpServer, Tool, Toolkit } from 'effect/unstable/ai';
const GreetTool = Tool.make('GreetTool', {
description: 'Generate a greeting',
parameters: { name: Schema.String },
success: Schema.String
});
const MyToolkit = Toolkit.make(GreetTool);
const ReadmeResource = McpServer.resource({
uri: 'file:///README.md',
name: 'README',
mimeType: 'text/markdown',
content: Effect.succeed('# Demo MCP Server')
});
const idParam = McpSchema.param('id', Schema.NumberFromString);
const ItemResource = McpServer.resource`file://items/${idParam}`({
name: 'Item',
completion: { id: () => Effect.succeed([1, 2, 3]) },
content: Effect.fn(function* (_uri, id) {
return JSON.stringify({ id, name: `Item ${id}` });
}),
mimeType: 'application/json'
});
const HelpPrompt = McpServer.prompt({
name: 'Help',
description: 'Get help on a topic',
parameters: { topic: Schema.String },
completion: { topic: () => Effect.succeed(['setup', 'usage', 'api']) },
content: ({ topic }) => Effect.succeed(`Help me understand ${topic}`)
});
const ServerLayer = Layer.mergeAll(
ReadmeResource,
ItemResource,
HelpPrompt,
McpServer.toolkit(MyToolkit).pipe(
Layer.provideMerge(
MyToolkit.toLayer({
GreetTool: ({ name }) => Effect.succeed(`Hello, ${name}!`)
})
)
)
).pipe(
Layer.provide(
McpServer.layerStdio({
name: 'Demo MCP Server',
version: '1.0.0'
})
),
Layer.provide(NodeStdio.layer),
Layer.provide(Logger.layer([Logger.consolePretty({ stderr: true })]))
);
Layer.launch(ServerLayer).pipe(NodeRuntime.runMain);
Common Patterns
Tool with effectful implementation
const FetchTool = Tool.make('FetchData', {
description: 'Fetch data from database',
parameters: { id: Schema.String },
success: Schema.String
});
const FetchToolkit = Toolkit.make(FetchTool);
McpServer.toolkit(FetchToolkit).pipe(
Layer.provideMerge(
FetchToolkit.toLayer({
FetchData: ({ id }) =>
Effect.gen(function* () {
const db = yield* DatabaseService;
const result = yield* db.findById(id);
return JSON.stringify(result);
})
})
)
);
Multiple toolkits
const ServerLayer = Layer.mergeAll(
McpServer.toolkit(ReadToolkit).pipe(
Layer.provideMerge(
ReadToolkit.toLayer({
})
)
),
McpServer.toolkit(WriteToolkit).pipe(
Layer.provideMerge(
WriteToolkit.toLayer({
})
)
)
);
Resource content from Effect services
const ConfigResource = McpServer.resource({
uri: 'app://config',
name: 'App Config',
content: Effect.gen(function* () {
const config = yield* ConfigService;
return JSON.stringify(yield* config.getAll());
})
});
Key Rules
- Always merge part layers with
Layer.mergeAll — resources, prompts, and toolkit layers are independent and produce Layer<never, never, ...>
- Provide transport last —
Layer.provide(McpServer.layerStdio(...)) or Layer.provide(McpServer.layerHttp(...))
- stderr for stdio — Never log to stdout when using stdio transport
- Toolkit pattern —
McpServer.toolkit(tk).pipe(Layer.provideMerge(tk.toLayer({...}))) is the canonical pattern
- Schema for parameters — All tool parameters and resource template params use Effect Schema
McpSchema.param — Use for resource URI template parameters with automatic string codec
Effect.fn — Use for resource template content handlers that receive multiple arguments
- Launch with
Layer.launch — The server runs as a long-lived layer: Layer.launch(ServerLayer).pipe(NodeRuntime.runMain)