Router

View the source code for this module on GitHub: https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/router.py

MCP Router for organizing tools, resources, and prompts into modules.

MCPRouter

from mcp_use.server.router import MCPRouter

`method` init

Create a new MCP router.Parameters

str
default:""
Optional prefix to add to all tool/resource names when included.

list[str] | None
default:"None"
Optional tags for documentation/organization purposes.

Signature

def __init__(prefix: str = "", tags: list[str] | None = None):

`method` include_router

Include another router’s tools, resources, and prompts into this router.This allows for nested router organization.Parameters

MCPRouter
required
The router to include

str
default:""
Additional prefix to add to included items

Signature

def include_router(router: MCPRouter, prefix: str = ""):

`method` prompt

Decorator to register a prompt with this router.Example:

@router.prompt()
def greeting_prompt(name: str) -> str:
    return f"Hello, \{name\}! How can I help you today?"

Parameters

str | None
default:"None"
Prompt name (defaults to function name)

str | None
default:"None"
Prompt description

Returns

Callable

Signature

def prompt(name: str | None = None, description: str | None = None):

`property` prompts

Get all pending prompts in this router.Returns

list[mcp_use.server.router.PendingPrompt]

Signature

def prompts():

`method` resource

Decorator to register a resource with this router.Example:

@router.resource(uri="config://app")
def get_config() -> str:
    return '\{"setting": "value"\}'

Parameters

str
required
Resource URI (required, e.g., “config://app” or “file://data.json”)

str | None
default:"None"
Human-readable name

str | None
default:"None"
Resource description

str | None
default:"None"
MIME type of the resource content

Returns

Callable

Signature

def resource(
uri: str,
    name: str | None = None,
    description: str | None = None,
    mime_type: str | None = None
):

`property` resources

Get all pending resources in this router.Returns

list[mcp_use.server.router.PendingResource]

Signature

def resources():

`method` tool

Decorator to register a tool with this router.Example:

@router.tool()
def my_tool(arg: str) -> str:
    '''Tool description here.'''
    return f"Result: \{arg\}"

Parameters

str | None
default:"None"
Override the tool name (defaults to function name)

str | None
default:"None"
Human-readable title for the tool

str | None
default:"None"
Tool description (defaults to function docstring)

mcp.types.ToolAnnotations | None
default:"None"
MCP tool annotations

bool | None
default:"None"
Whether the tool returns structured output

Returns

Callable

Signature

def tool(
name: str | None = None,
    title: str | None = None,
    description: str | None = None,
    annotations: mcp.types.ToolAnnotations | None = None,
    structured_output: bool | None = None
):

`property` tools

Get all pending tools in this router.Returns

list[mcp_use.server.router.PendingTool]

Signature

def tools():

PendingPrompt

from mcp_use.server.router import PendingPrompt

Attributes

Callable

required

Parameter value

str | None

required

Name identifier

str | None

required

String value

`method` init

Parameters

Callable
required
Parameter value

str | None
default:"None"
Name identifier

str | None
default:"None"
String value

Signature

def __init__(fn: Callable, name: str | None = None, description: str | None = None):

PendingResource

from mcp_use.server.router import PendingResource

Attributes

Callable

required

Parameter value

str

required

String value

str | None

required

Name identifier

str | None

required

String value

str | None

required

String value

`method` init

Parameters

Callable
required
Parameter value

str
required
String value

str | None
default:"None"
Name identifier

str | None
default:"None"
String value

str | None
default:"None"
String value

Signature

def __init__(fn: Callable, uri: str, name: str | None = None, description: str | None = None, mime_type: str | None = None):

PendingTool

from mcp_use.server.router import PendingTool

Attributes

Callable

required

Parameter value

str | None

required

Name identifier

str | None

required

String value

str | None

required

String value

mcp.types.ToolAnnotations | None

required

Parameter value

bool | None

required

Boolean flag

`method` init

Parameters

Callable
required
Parameter value

str | None
default:"None"
Name identifier

str | None
default:"None"
String value

str | None
default:"None"
String value

mcp.types.ToolAnnotations | None
default:"None"
Parameter value

bool | None
default:"None"
Boolean flag

Signature

def __init__(fn: Callable, name: str | None = None, title: str | None = None, description: str | None = None, annotations: mcp.types.ToolAnnotations | None = None, structured_output: bool | None = None):

Agents

Client

Core

Errors

Server

MCPRouter

`method` init

`method` include_router

`method` prompt

`property` prompts

`method` resource

`property` resources

`method` tool

`property` tools

PendingPrompt

`method` init

PendingResource

`method` init

PendingTool

`method` init

​MCPRouter

​method init

​method include_router

​method prompt

​property prompts

​method resource

​property resources

​method tool

​property tools

​PendingPrompt

​method init

​PendingResource

​method init

​PendingTool

​method init

MCPRouter

`method` init

`method` include_router

`method` prompt

`property` prompts

`method` resource

`property` resources

`method` tool

`property` tools

PendingPrompt

`method` init

PendingResource

`method` init

PendingTool

`method` init