Skip to content

Rename Error to MCPError #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattt merged 7 commits into from
Apr 3, 2025
Merged

Rename Error to MCPError #44

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d498b28
Rename Error to MCPError
mattt Apr 3, 2025
39e905e
Conform MCPError to Swift.Error
mattt Apr 3, 2025
6a70c2d
Use unqualified Error instead of Swift.Error
mattt Apr 3, 2025
3bd2649
Use unqualified MCPError instead of MCP.MCPError
mattt Apr 3, 2025
deabf00
Rename file back to Error.swift
mattt Apr 3, 2025
68c455b
Introduce top-level MCP namespace with nested Error typealias to prov…
mattt Apr 3, 2025
20f127a
Fix markup for MCP enum warning
mattt Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Sources/MCP/Base/Error.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ import Foundation
@preconcurrency import SystemPackage
#endif

/// Top-level namespace for backward compatibility
///
/// This is provided to allow existing code that uses `MCP.Error` to continue
/// to work without modification.
///
/// The MCPError type is now the recommended way to handle errors in MCP.
///
/// @warning This namespace is deprecated and will be removed in a future version.
public enum MCP {
/// Deprecated type alias for MCPError
@available(*, deprecated, renamed: "MCPError", message: "Use MCPError instead of MCP.Error")
public typealias Error = MCPError
}

// MARK: -

/// A model context protocol error.
public enum MCPError: Error, Sendable {
// Standard JSON-RPC 2.0 errors (-32700 to -32603)
Expand Down
12 changes: 8 additions & 4 deletions Tests/MCPTests/Helpers/MockTransport.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import Foundation
import class Foundation.JSONEncoder
import class Foundation.JSONDecoder
import struct Foundation.Data
import struct Foundation.POSIXError
Comment on lines +1 to +4
Copy link
Contributor Author

@mattt mattt Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason why someone might need to fully-qualify MCP.Method or MCP.Notification is to fix a different namespace collision with Foundation.

As a workaround, you can import individual declarations as needed. Apologies in advance for any inconvenience this causes 🙇


import Logging

@testable import MCP
Expand Down Expand Up @@ -76,7 +80,7 @@ actor MockTransport: Transport {
shouldFailSend = shouldFail
}

func queue<M: MCP.Method>(request: Request<M>) throws {
func queue<M: Method>(request: Request<M>) throws {
let data = try encoder.encode(request)
if let continuation = dataStreamContinuation {
continuation.yield(data)
Expand All @@ -85,12 +89,12 @@ actor MockTransport: Transport {
}
}

func queue<M: MCP.Method>(response: Response<M>) throws {
func queue<M: Method>(response: Response<M>) throws {
let data = try encoder.encode(response)
dataToReceive.append(data)
}

func queue<N: MCP.Notification>(notification: Message<N>) throws {
func queue<N: Notification>(notification: Message<N>) throws {
let data = try encoder.encode(notification)
dataToReceive.append(data)
}
Expand Down