Skip to content

page.mdx

Latest commit

 

History

History
172 lines (126 loc) · 4.06 KB

page.mdx

File metadata and controls

172 lines (126 loc) · 4.06 KB
title Server - Arcade MCP Python Reference
description Reference documentation for the Arcade MCP Server class

Server

Low-level server for hosting Arcade tools over MCP.

MCPServer

arcade_mcp_server.server.MCPServer

MCP Server with middleware and context support.

This server provides:

  • Middleware chain for extensible request processing
  • Context injection for tools
  • Component managers for tools, resources, and prompts
  • Bidirectional communication support to MCP clients

Properties

prompts

Access the PromptManager for runtime prompt operations.

resources

Access the ResourceManager for runtime resource operations.

tools

Access the ToolManager for runtime tool operations.

Methods

__init__

__init__(
    catalog,
    *,
    name='ArcadeMCP',
    version='0.1.0',
    title=None,
    instructions=None,
    settings=None,
    middleware=None,
    lifespan=None,
    auth_disabled=False,
    arcade_api_key=None,
    arcade_api_url=None
)

Initialize MCP server.

Parameters:

Name Type Description Default
catalog ToolCatalog Tool catalog required
name str Server name 'ArcadeMCP'
version str Server version '0.1.0'
title str | None Server title for display None
instructions str | None Server instructions None
settings MCPSettings | None MCP settings (uses env if not provided) None
middleware list[Middleware] | None List of middleware to apply None
lifespan Callable[[Any], Any] | None Lifespan manager function None
auth_disabled bool Disable authentication False
arcade_api_key str | None Arcade API key (overrides settings) None
arcade_api_url str | None Arcade API URL (overrides settings) None

start

async start()

Initialize the server. Call before running a transport.

stop

async stop()

Gracefully shut down the server.

handle_message

async handle_message(message, session=None)

Handle an incoming message.

Parameters:

Name Type Description Default
message Any Message to handle required
session ServerSession | None Server session None

Returns:

Type Description
MCPMessage | None Response message or None

run_connection

async run_connection(read_stream, write_stream, init_options=None)

Run a single MCP connection.

Parameters:

Name Type Description Default
read_stream Any Stream for reading messages required
write_stream Any Stream for writing messages required
init_options Any Connection initialization options None

Examples

Basic server with tool catalog and stdio transport

import asyncio
from arcade_mcp_server.server import MCPServer
from arcade_core.catalog import ToolCatalog
from arcade_mcp_server.transports.stdio import StdioTransport

async def main():
    catalog = ToolCatalog()
    server = MCPServer(catalog=catalog, name="example", version="1.0.0")
    await server.start()
    try:
        # Run stdio transport loop
        transport = StdioTransport()
        await transport.run(server)
    finally:
        await server.stop()

if __name__ == "__main__":
    asyncio.run(main())

Handling a single HTTP streamable connection

import asyncio
from arcade_mcp_server.server import MCPServer
from arcade_core.catalog import ToolCatalog
from arcade_mcp_server.transports.http_streamable import HTTPStreamableTransport

async def run_http():
    catalog = ToolCatalog()
    server = MCPServer(catalog=catalog)
    await server.start()
    try:
        transport = HTTPStreamableTransport(host="0.0.0.0", port=8000)
        await transport.run(server)
    finally:
        await server.stop()

asyncio.run(run_http())