Skip to content

Latest commit

 

History

History
91 lines (74 loc) · 2.72 KB

ref-index.md

File metadata and controls

91 lines (74 loc) · 2.72 KB
Raw

Spring AI MCP Reference Documentation

This documentation covers the Spring AI implementation of the Model Context Protocol (MCP) specification. The implementation follows the official MCP specification.

Component Hierarchy

1. Transport Layer

Transport

  • McpTransport Interface
  • Transport Implementations (SSE, STDIO)
  • Message Serialization/Deserialization

2. Session Layer

Session Management

  • McpSession Interface
  • DefaultMcpSession Implementation
  • Uses McpTransport for communication

3. High-Level Components

Both components operate at the same level, using McpSession internally:

Client

  • McpClient Factory
  • Synchronous and Asynchronous Implementations
  • Client Configuration and Builder Pattern

Server

  • McpServer Factory
  • Synchronous and Asynchronous Implementations
  • Server Configuration and Builder Pattern

4. Supporting Components

Error Handling

  • McpError
  • Error Codes and Handling
  • Exception Hierarchy

Component Relationships

┌─────────────┐    ┌─────────────┐
│  McpClient  │    │  McpServer  │
└─────────────┘    └─────────────┘
       │                  │
       └─────────┬────────┘
                 │
         ┌───────────────┐
         │   McpSession  │
         └───────────────┘
                 │
         ┌───────────────┐
         │  McpTransport │
         └───────────────┘

Package Organization

The implementation is organized under the org.springframework.ai.mcp package with the following structure:

  • org.springframework.ai.mcp.spec - Core interfaces and classes
    • McpTransport
    • McpSession
    • McpSchema
    • McpError
  • org.springframework.ai.mcp.client - Client implementations
    • McpClient
    • McpAsyncClient
    • McpSyncClient
    • Client-specific transports
  • org.springframework.ai.mcp.server - Server implementations
    • McpServer
    • McpAsyncServer
    • McpSyncServer
    • Server-specific transports
  • org.springframework.ai.mcp.util - Utility classes
    • Assert
    • Utils

Key Features

  • Synchronous and Asynchronous implementations
  • Multiple transport options (SSE, STDIO)
  • Comprehensive error handling
  • Builder pattern for configuration
  • Reactive programming support with Project Reactor
  • Type-safe message handling
  • Resource and prompt management
  • Tool discovery and execution
  • Change notification system