MCPKit.Router (mcp_kit v0.2.4)

Phoenix router DSL for mounting an MCP endpoint and declaring exposed tools, prompts, and resources.

Typical usage:

mcp_scope "/mcp", MyApp.MCP do
  tool "project_create", Tools.ProjectCreate
  tool "project_status", Tools.ProjectStatus
  prompt "draft_release_notes", Prompts.DraftReleaseNotes
  resource "project", Resources.Project
end

The second argument behaves like a regular Phoenix scope alias. Given the example above, Tools.ProjectCreate resolves to MyApp.MCP.Tools.ProjectCreate.

mcp_scope/2 and mcp_scope/3 generate the underlying route automatically, so the host router does not need a separate MCP pipeline or forward call.

Runtime state is handled by a host-started MCPKit.Runtime child. The router infers its name from the definition module unless overridden with runtime:.

resource/2 mounts MCP resources for the scope.

Summary

Functions

mcp_scope(path, second \\ [], list)

Mounts an MCP endpoint under the given router path.

mcp_scope(path, scope_alias, options, list)

Mounts an MCP endpoint under the given router path with an explicit scope alias and options.

prompt(name_ast, module_ast)

Declares a prompt inside mcp_scope.

resource(name_ast, module_ast)

Declares a resource inside mcp_scope.

tool(name_ast, module_ast)

Declares a tool inside mcp_scope.

Functions

mcp_scope(path, second \\ [], list)

(macro)

Mounts an MCP endpoint under the given router path.

The second argument may be either a scope alias or router options. When a scope alias is given, mcp_scope/2 infers a sibling Definition module and runtime name from that scope.

Inside the block you may declare tool/2, prompt/2, and resource/2 entries.

mcp_scope(path, scope_alias, options, list)

(macro)

Mounts an MCP endpoint under the given router path with an explicit scope alias and options.

Supports definition: to override the inferred Definition module and runtime: to override the inferred runtime name.

prompt(name_ast, module_ast)

(macro)

Declares a prompt inside mcp_scope.

The prompt name is exposed over MCP and the module must implement MCPKit.Prompt.

resource(name_ast, module_ast)

(macro)

Declares a resource inside mcp_scope.

The resource name is used for policy and completion routing, and the module must implement MCPKit.Resource.

tool(name_ast, module_ast)

(macro)

Declares a tool inside mcp_scope.

The tool name is exposed over MCP and the module must implement MCPKit.Tool.