* Add UnitInterval type * Add test coverage for UnitInterval * Add support for sampling * Add integration tests for sampling
642 lines
23 KiB
Swift
642 lines
23 KiB
Swift
import Logging
|
|
|
|
import struct Foundation.Data
|
|
import struct Foundation.Date
|
|
import class Foundation.JSONDecoder
|
|
import class Foundation.JSONEncoder
|
|
|
|
/// Model Context Protocol server
|
|
public actor Server {
|
|
/// The server configuration
|
|
public struct Configuration: Hashable, Codable, Sendable {
|
|
/// The default configuration.
|
|
public static let `default` = Configuration(strict: false)
|
|
|
|
/// The strict configuration.
|
|
public static let strict = Configuration(strict: true)
|
|
|
|
/// When strict mode is enabled, the server:
|
|
/// - Requires clients to send an initialize request before any other requests
|
|
/// - Rejects all requests from uninitialized clients with a protocol error
|
|
///
|
|
/// While the MCP specification requires clients to initialize the connection
|
|
/// before sending other requests, some implementations may not follow this.
|
|
/// Disabling strict mode allows the server to be more lenient with non-compliant
|
|
/// clients, though this may lead to undefined behavior.
|
|
public var strict: Bool
|
|
}
|
|
|
|
/// Implementation information
|
|
public struct Info: Hashable, Codable, Sendable {
|
|
/// The server name
|
|
public let name: String
|
|
/// The server version
|
|
public let version: String
|
|
|
|
public init(name: String, version: String) {
|
|
self.name = name
|
|
self.version = version
|
|
}
|
|
}
|
|
|
|
/// Server capabilities
|
|
public struct Capabilities: Hashable, Codable, Sendable {
|
|
/// Resources capabilities
|
|
public struct Resources: Hashable, Codable, Sendable {
|
|
/// Whether the resource can be subscribed to
|
|
public var subscribe: Bool?
|
|
/// Whether the list of resources has changed
|
|
public var listChanged: Bool?
|
|
|
|
public init(
|
|
subscribe: Bool? = nil,
|
|
listChanged: Bool? = nil
|
|
) {
|
|
self.subscribe = subscribe
|
|
self.listChanged = listChanged
|
|
}
|
|
}
|
|
|
|
/// Tools capabilities
|
|
public struct Tools: Hashable, Codable, Sendable {
|
|
/// Whether the server notifies clients when tools change
|
|
public var listChanged: Bool?
|
|
|
|
public init(listChanged: Bool? = nil) {
|
|
self.listChanged = listChanged
|
|
}
|
|
}
|
|
|
|
/// Prompts capabilities
|
|
public struct Prompts: Hashable, Codable, Sendable {
|
|
/// Whether the server notifies clients when prompts change
|
|
public var listChanged: Bool?
|
|
|
|
public init(listChanged: Bool? = nil) {
|
|
self.listChanged = listChanged
|
|
}
|
|
}
|
|
|
|
/// Logging capabilities
|
|
public struct Logging: Hashable, Codable, Sendable {
|
|
public init() {}
|
|
}
|
|
|
|
/// Sampling capabilities
|
|
public struct Sampling: Hashable, Codable, Sendable {
|
|
public init() {}
|
|
}
|
|
|
|
/// Logging capabilities
|
|
public var logging: Logging?
|
|
/// Prompts capabilities
|
|
public var prompts: Prompts?
|
|
/// Resources capabilities
|
|
public var resources: Resources?
|
|
/// Sampling capabilities
|
|
public var sampling: Sampling?
|
|
/// Tools capabilities
|
|
public var tools: Tools?
|
|
|
|
public init(
|
|
logging: Logging? = nil,
|
|
prompts: Prompts? = nil,
|
|
resources: Resources? = nil,
|
|
sampling: Sampling? = nil,
|
|
tools: Tools? = nil
|
|
) {
|
|
self.logging = logging
|
|
self.prompts = prompts
|
|
self.resources = resources
|
|
self.sampling = sampling
|
|
self.tools = tools
|
|
}
|
|
}
|
|
|
|
/// Server information
|
|
private let serverInfo: Server.Info
|
|
/// The server connection
|
|
private var connection: (any Transport)?
|
|
/// The server logger
|
|
private var logger: Logger? {
|
|
get async {
|
|
await connection?.logger
|
|
}
|
|
}
|
|
|
|
/// The server name
|
|
public nonisolated var name: String { serverInfo.name }
|
|
/// The server version
|
|
public nonisolated var version: String { serverInfo.version }
|
|
/// The server capabilities
|
|
public var capabilities: Capabilities
|
|
/// The server configuration
|
|
public var configuration: Configuration
|
|
|
|
/// Request handlers
|
|
private var methodHandlers: [String: RequestHandlerBox] = [:]
|
|
/// Notification handlers
|
|
private var notificationHandlers: [String: [NotificationHandlerBox]] = [:]
|
|
|
|
/// Whether the server is initialized
|
|
private var isInitialized = false
|
|
/// The client information
|
|
private var clientInfo: Client.Info?
|
|
/// The client capabilities
|
|
private var clientCapabilities: Client.Capabilities?
|
|
/// The protocol version
|
|
private var protocolVersion: String?
|
|
/// The list of subscriptions
|
|
private var subscriptions: [String: Set<ID>] = [:]
|
|
/// The task for the message handling loop
|
|
private var task: Task<Void, Never>?
|
|
|
|
public init(
|
|
name: String,
|
|
version: String,
|
|
capabilities: Server.Capabilities = .init(),
|
|
configuration: Configuration = .default
|
|
) {
|
|
self.serverInfo = Server.Info(name: name, version: version)
|
|
self.capabilities = capabilities
|
|
self.configuration = configuration
|
|
}
|
|
|
|
/// Start the server
|
|
/// - Parameters:
|
|
/// - transport: The transport to use for the server
|
|
/// - initializeHook: An optional hook that runs when the client sends an initialize request
|
|
public func start(
|
|
transport: any Transport,
|
|
initializeHook: (@Sendable (Client.Info, Client.Capabilities) async throws -> Void)? = nil
|
|
) async throws {
|
|
self.connection = transport
|
|
registerDefaultHandlers(initializeHook: initializeHook)
|
|
try await transport.connect()
|
|
|
|
await logger?.info(
|
|
"Server started", metadata: ["name": "\(name)", "version": "\(version)"])
|
|
|
|
// Start message handling loop
|
|
task = Task {
|
|
do {
|
|
let stream = await transport.receive()
|
|
for try await data in stream {
|
|
if Task.isCancelled { break } // Check cancellation inside loop
|
|
|
|
var requestID: ID?
|
|
do {
|
|
// Attempt to decode as batch first, then as individual request or notification
|
|
let decoder = JSONDecoder()
|
|
if let batch = try? decoder.decode(Server.Batch.self, from: data) {
|
|
try await handleBatch(batch)
|
|
} else if let request = try? decoder.decode(AnyRequest.self, from: data) {
|
|
_ = try await handleRequest(request, sendResponse: true)
|
|
} else if let message = try? decoder.decode(AnyMessage.self, from: data) {
|
|
try await handleMessage(message)
|
|
} else {
|
|
// Try to extract request ID from raw JSON if possible
|
|
if let json = try? JSONDecoder().decode(
|
|
[String: Value].self, from: data),
|
|
let idValue = json["id"]
|
|
{
|
|
if let strValue = idValue.stringValue {
|
|
requestID = .string(strValue)
|
|
} else if let intValue = idValue.intValue {
|
|
requestID = .number(intValue)
|
|
}
|
|
}
|
|
throw MCPError.parseError("Invalid message format")
|
|
}
|
|
} catch let error where MCPError.isResourceTemporarilyUnavailable(error) {
|
|
// Resource temporarily unavailable, retry after a short delay
|
|
try? await Task.sleep(for: .milliseconds(10))
|
|
continue
|
|
} catch {
|
|
await logger?.error(
|
|
"Error processing message", metadata: ["error": "\(error)"])
|
|
let response = AnyMethod.response(
|
|
id: requestID ?? .random,
|
|
error: error as? MCPError
|
|
?? MCPError.internalError(error.localizedDescription)
|
|
)
|
|
try? await send(response)
|
|
}
|
|
}
|
|
} catch {
|
|
await logger?.error(
|
|
"Fatal error in message handling loop", metadata: ["error": "\(error)"])
|
|
}
|
|
await logger?.info("Server finished", metadata: [:])
|
|
}
|
|
}
|
|
|
|
/// Stop the server
|
|
public func stop() async {
|
|
task?.cancel()
|
|
task = nil
|
|
if let connection = connection {
|
|
await connection.disconnect()
|
|
}
|
|
connection = nil
|
|
}
|
|
|
|
public func waitUntilCompleted() async {
|
|
await task?.value
|
|
}
|
|
|
|
// MARK: - Registration
|
|
|
|
/// Register a method handler
|
|
@discardableResult
|
|
public func withMethodHandler<M: Method>(
|
|
_ type: M.Type,
|
|
handler: @escaping @Sendable (M.Parameters) async throws -> M.Result
|
|
) -> Self {
|
|
methodHandlers[M.name] = TypedRequestHandler { (request: Request<M>) -> Response<M> in
|
|
let result = try await handler(request.params)
|
|
return Response(id: request.id, result: result)
|
|
}
|
|
return self
|
|
}
|
|
|
|
/// Register a notification handler
|
|
@discardableResult
|
|
public func onNotification<N: Notification>(
|
|
_ type: N.Type,
|
|
handler: @escaping @Sendable (Message<N>) async throws -> Void
|
|
) -> Self {
|
|
let handlers = notificationHandlers[N.name, default: []]
|
|
notificationHandlers[N.name] = handlers + [TypedNotificationHandler(handler)]
|
|
return self
|
|
}
|
|
|
|
// MARK: - Sending
|
|
|
|
/// Send a response to a request
|
|
public func send<M: Method>(_ response: Response<M>) async throws {
|
|
guard let connection = connection else {
|
|
throw MCPError.internalError("Server connection not initialized")
|
|
}
|
|
|
|
let encoder = JSONEncoder()
|
|
encoder.outputFormatting = [.sortedKeys, .withoutEscapingSlashes]
|
|
|
|
let responseData = try encoder.encode(response)
|
|
try await connection.send(responseData)
|
|
}
|
|
|
|
/// Send a notification to connected clients
|
|
public func notify<N: Notification>(_ notification: Message<N>) async throws {
|
|
guard let connection = connection else {
|
|
throw MCPError.internalError("Server connection not initialized")
|
|
}
|
|
|
|
let encoder = JSONEncoder()
|
|
encoder.outputFormatting = [.sortedKeys, .withoutEscapingSlashes]
|
|
|
|
let notificationData = try encoder.encode(notification)
|
|
try await connection.send(notificationData)
|
|
}
|
|
|
|
// MARK: - Sampling
|
|
|
|
/// Request sampling from the connected client
|
|
///
|
|
/// Sampling allows servers to request LLM completions through the client,
|
|
/// enabling sophisticated agentic behaviors while maintaining human-in-the-loop control.
|
|
///
|
|
/// The sampling flow follows these steps:
|
|
/// 1. Server sends a `sampling/createMessage` request to the client
|
|
/// 2. Client reviews the request and can modify it
|
|
/// 3. Client samples from an LLM
|
|
/// 4. Client reviews the completion
|
|
/// 5. Client returns the result to the server
|
|
///
|
|
/// - Parameters:
|
|
/// - messages: The conversation history to send to the LLM
|
|
/// - modelPreferences: Model selection preferences
|
|
/// - systemPrompt: Optional system prompt
|
|
/// - includeContext: What MCP context to include
|
|
/// - temperature: Controls randomness (0.0 to 1.0)
|
|
/// - maxTokens: Maximum tokens to generate
|
|
/// - stopSequences: Array of sequences that stop generation
|
|
/// - metadata: Additional provider-specific parameters
|
|
/// - Returns: The sampling result containing the model used, stop reason, role, and content
|
|
/// - Throws: MCPError if the request fails
|
|
/// - SeeAlso: https://modelcontextprotocol.io/docs/concepts/sampling#how-sampling-works
|
|
public func requestSampling(
|
|
messages: [Sampling.Message],
|
|
modelPreferences: Sampling.ModelPreferences? = nil,
|
|
systemPrompt: String? = nil,
|
|
includeContext: Sampling.ContextInclusion? = nil,
|
|
temperature: Double? = nil,
|
|
maxTokens: Int,
|
|
stopSequences: [String]? = nil,
|
|
metadata: [String: Value]? = nil
|
|
) async throws -> CreateSamplingMessage.Result {
|
|
guard connection != nil else {
|
|
throw MCPError.internalError("Server connection not initialized")
|
|
}
|
|
|
|
// Note: This is a conceptual implementation. The actual implementation would require
|
|
// bidirectional communication support in the transport layer, allowing servers to
|
|
// send requests to clients and receive responses.
|
|
|
|
_ = CreateSamplingMessage.request(
|
|
.init(
|
|
messages: messages,
|
|
modelPreferences: modelPreferences,
|
|
systemPrompt: systemPrompt,
|
|
includeContext: includeContext,
|
|
temperature: temperature,
|
|
maxTokens: maxTokens,
|
|
stopSequences: stopSequences,
|
|
metadata: metadata
|
|
)
|
|
)
|
|
|
|
// This would need to be implemented with proper request/response handling
|
|
// similar to how the client sends requests to servers
|
|
throw MCPError.internalError(
|
|
"Bidirectional sampling requests not yet implemented in transport layer")
|
|
}
|
|
|
|
/// A JSON-RPC batch containing multiple requests and/or notifications
|
|
struct Batch: Sendable {
|
|
/// An item in a JSON-RPC batch
|
|
enum Item: Sendable {
|
|
case request(Request<AnyMethod>)
|
|
case notification(Message<AnyNotification>)
|
|
|
|
}
|
|
|
|
var items: [Item]
|
|
|
|
init(items: [Item]) {
|
|
self.items = items
|
|
}
|
|
}
|
|
|
|
/// Process a batch of requests and/or notifications
|
|
private func handleBatch(_ batch: Batch) async throws {
|
|
await logger?.debug("Processing batch request", metadata: ["size": "\(batch.items.count)"])
|
|
|
|
if batch.items.isEmpty {
|
|
// Empty batch is invalid according to JSON-RPC spec
|
|
let error = MCPError.invalidRequest("Batch array must not be empty")
|
|
let response = AnyMethod.response(id: .random, error: error)
|
|
try await send(response)
|
|
return
|
|
}
|
|
|
|
// Process each item in the batch and collect responses
|
|
var responses: [Response<AnyMethod>] = []
|
|
|
|
for item in batch.items {
|
|
do {
|
|
switch item {
|
|
case .request(let request):
|
|
// For batched requests, collect responses instead of sending immediately
|
|
if let response = try await handleRequest(request, sendResponse: false) {
|
|
responses.append(response)
|
|
}
|
|
|
|
case .notification(let notification):
|
|
// Handle notification (no response needed)
|
|
try await handleMessage(notification)
|
|
}
|
|
} catch {
|
|
// Only add errors to response for requests (notifications don't have responses)
|
|
if case .request(let request) = item {
|
|
let mcpError =
|
|
error as? MCPError ?? MCPError.internalError(error.localizedDescription)
|
|
responses.append(AnyMethod.response(id: request.id, error: mcpError))
|
|
}
|
|
}
|
|
}
|
|
|
|
// Send collected responses if any
|
|
if !responses.isEmpty {
|
|
let encoder = JSONEncoder()
|
|
encoder.outputFormatting = [.sortedKeys, .withoutEscapingSlashes]
|
|
let responseData = try encoder.encode(responses)
|
|
|
|
guard let connection = connection else {
|
|
throw MCPError.internalError("Server connection not initialized")
|
|
}
|
|
|
|
try await connection.send(responseData)
|
|
}
|
|
}
|
|
|
|
// MARK: - Request and Message Handling
|
|
|
|
/// Handle a request and either send the response immediately or return it
|
|
///
|
|
/// - Parameters:
|
|
/// - request: The request to handle
|
|
/// - sendResponse: Whether to send the response immediately (true) or return it (false)
|
|
/// - Returns: The response when sendResponse is false
|
|
private func handleRequest(_ request: Request<AnyMethod>, sendResponse: Bool = true)
|
|
async throws -> Response<AnyMethod>?
|
|
{
|
|
// Check if this is a pre-processed error request (empty method)
|
|
if request.method.isEmpty && !sendResponse {
|
|
// This is a placeholder for an invalid request that couldn't be parsed in batch mode
|
|
return AnyMethod.response(
|
|
id: request.id,
|
|
error: MCPError.invalidRequest("Invalid batch item format")
|
|
)
|
|
}
|
|
|
|
await logger?.debug(
|
|
"Processing request",
|
|
metadata: [
|
|
"method": "\(request.method)",
|
|
"id": "\(request.id)",
|
|
])
|
|
|
|
if configuration.strict {
|
|
// The client SHOULD NOT send requests other than pings
|
|
// before the server has responded to the initialize request.
|
|
switch request.method {
|
|
case Initialize.name, Ping.name:
|
|
break
|
|
default:
|
|
try checkInitialized()
|
|
}
|
|
}
|
|
|
|
// Find handler for method name
|
|
guard let handler = methodHandlers[request.method] else {
|
|
let error = MCPError.methodNotFound("Unknown method: \(request.method)")
|
|
let response = AnyMethod.response(id: request.id, error: error)
|
|
|
|
if sendResponse {
|
|
try await send(response)
|
|
return nil
|
|
}
|
|
|
|
return response
|
|
}
|
|
|
|
do {
|
|
// Handle request and get response
|
|
let response = try await handler(request)
|
|
|
|
if sendResponse {
|
|
try await send(response)
|
|
return nil
|
|
}
|
|
|
|
return response
|
|
} catch {
|
|
let mcpError = error as? MCPError ?? MCPError.internalError(error.localizedDescription)
|
|
let response = AnyMethod.response(id: request.id, error: mcpError)
|
|
|
|
if sendResponse {
|
|
try await send(response)
|
|
return nil
|
|
}
|
|
|
|
return response
|
|
}
|
|
}
|
|
|
|
private func handleMessage(_ message: Message<AnyNotification>) async throws {
|
|
await logger?.debug(
|
|
"Processing notification",
|
|
metadata: ["method": "\(message.method)"])
|
|
|
|
if configuration.strict {
|
|
// Check initialization state unless this is an initialized notification
|
|
if message.method != InitializedNotification.name {
|
|
try checkInitialized()
|
|
}
|
|
}
|
|
|
|
// Find notification handlers for this method
|
|
guard let handlers = notificationHandlers[message.method] else { return }
|
|
|
|
// Convert notification parameters to concrete type and call handlers
|
|
for handler in handlers {
|
|
do {
|
|
try await handler(message)
|
|
} catch {
|
|
await logger?.error(
|
|
"Error handling notification",
|
|
metadata: [
|
|
"method": "\(message.method)",
|
|
"error": "\(error)",
|
|
])
|
|
}
|
|
}
|
|
}
|
|
|
|
private func checkInitialized() throws {
|
|
guard isInitialized else {
|
|
throw MCPError.invalidRequest("Server is not initialized")
|
|
}
|
|
}
|
|
|
|
private func registerDefaultHandlers(
|
|
initializeHook: (@Sendable (Client.Info, Client.Capabilities) async throws -> Void)?
|
|
) {
|
|
// Initialize
|
|
withMethodHandler(Initialize.self) { [weak self] params in
|
|
guard let self = self else {
|
|
throw MCPError.internalError("Server was deallocated")
|
|
}
|
|
|
|
guard await !self.isInitialized else {
|
|
throw MCPError.invalidRequest("Server is already initialized")
|
|
}
|
|
|
|
// Call initialization hook if registered
|
|
if let hook = initializeHook {
|
|
try await hook(params.clientInfo, params.capabilities)
|
|
}
|
|
|
|
// Perform version negotiation
|
|
let clientRequestedVersion = params.protocolVersion
|
|
let negotiatedProtocolVersion = Version.negotiate(
|
|
clientRequestedVersion: clientRequestedVersion)
|
|
|
|
// Set initial state with the negotiated protocol version
|
|
await self.setInitialState(
|
|
clientInfo: params.clientInfo,
|
|
clientCapabilities: params.capabilities,
|
|
protocolVersion: negotiatedProtocolVersion
|
|
)
|
|
|
|
return Initialize.Result(
|
|
protocolVersion: negotiatedProtocolVersion,
|
|
capabilities: await self.capabilities,
|
|
serverInfo: self.serverInfo,
|
|
instructions: nil
|
|
)
|
|
}
|
|
|
|
// Ping
|
|
withMethodHandler(Ping.self) { _ in return Empty() }
|
|
}
|
|
|
|
private func setInitialState(
|
|
clientInfo: Client.Info,
|
|
clientCapabilities: Client.Capabilities,
|
|
protocolVersion: String
|
|
) async {
|
|
self.clientInfo = clientInfo
|
|
self.clientCapabilities = clientCapabilities
|
|
self.protocolVersion = protocolVersion
|
|
self.isInitialized = true
|
|
}
|
|
}
|
|
|
|
extension Server.Batch: Codable {
|
|
init(from decoder: Decoder) throws {
|
|
let container = try decoder.singleValueContainer()
|
|
|
|
let encoder = JSONEncoder()
|
|
let decoder = JSONDecoder()
|
|
|
|
var items: [Item] = []
|
|
for item in try container.decode([Value].self) {
|
|
let data = try encoder.encode(item)
|
|
try items.append(decoder.decode(Item.self, from: data))
|
|
}
|
|
|
|
self.items = items
|
|
}
|
|
|
|
func encode(to encoder: Encoder) throws {
|
|
var container = encoder.singleValueContainer()
|
|
try container.encode(items)
|
|
}
|
|
}
|
|
|
|
extension Server.Batch.Item: Codable {
|
|
private enum CodingKeys: String, CodingKey {
|
|
case id
|
|
}
|
|
|
|
init(from decoder: Decoder) throws {
|
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
|
// Check if it's a request (has id) or notification (no id)
|
|
if container.contains(.id) {
|
|
self = .request(try Request<AnyMethod>(from: decoder))
|
|
} else {
|
|
self = .notification(try Message<AnyNotification>(from: decoder))
|
|
}
|
|
}
|
|
|
|
func encode(to encoder: Encoder) throws {
|
|
switch self {
|
|
case .request(let request):
|
|
try request.encode(to: encoder)
|
|
case .notification(let notification):
|
|
try notification.encode(to: encoder)
|
|
}
|
|
}
|
|
}
|