@midwayjs/mcp

Index

Classes

• Configuration
• MidwayMCPFramework

Functions

• Prompt
• Resource
• Tool

Interfaces

• Context
• IMcpPrompt
• IMcpResource
• IMcpTool
• IMidwayMCPConfigurationOptions
• IMidwayMCPContext

Type Aliases

• Application
• IMidwayMCPApplication
• NextFunction
• PromptConfig
• ResourceConfig
• ToolConfig

Variables

• MCP_PROMPT_KEY
• MCP_RESOURCE_KEY
• MCP_TOOL_KEY

Type Aliases

Application

Application: IMidwayMCPApplication

IMidwayMCPApplication

IMidwayMCPApplication: IMidwayApplication<IMidwayMCPContext>

NextFunction

NextFunction: BaseNextFunction

PromptConfig

PromptConfig<Args>: { argsSchema?: Args; description?: string; title?: string }

Type parameters

• Args: PromptArgsRawShape = any

ResourceConfig

ResourceConfig: { _meta?: Record<string, unknown>; description?: string; mimeType?: string; template?: ResourceTemplate; title?: string; uri?: string }

ToolConfig

ToolConfig<InputArgs, OutputArgs>: { _meta?: Record<string, unknown>; annotations?: ToolAnnotations; description?: string; inputSchema?: InputArgs; outputSchema?: OutputArgs; title?: string }

Type parameters

• InputArgs: ZodRawShape = any
• OutputArgs: ZodRawShape = any

Variables

constMCP_PROMPT_KEY

MCP_PROMPT_KEY: mcp:prompt = 'mcp:prompt'

constMCP_RESOURCE_KEY

MCP_RESOURCE_KEY: mcp:resource = 'mcp:resource'

constMCP_TOOL_KEY

MCP_TOOL_KEY: mcp:tool = 'mcp:tool'