Skip to content

Commit 310da4e

Browse files
committed
Update README with information about transports and platform availability
1 parent d583151 commit 310da4e

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,38 @@ Swift implementation of the [Model Context Protocol][mcp] (MCP).
66

77
- Swift 6.0+ (Xcode 16+)
88

9-
## Platform Support
10-
119
| Platform | Minimum Version |
1210
|----------|----------------|
1311
| macOS | 13.0+ |
1412
| iOS / Mac Catalyst | 16.0+ |
1513
| watchOS | 9.0+ |
1614
| tvOS | 16.0+ |
1715
| visionOS | 1.0+ |
18-
| Linux ||
19-
| Windows ||
20-
21-
> [!IMPORTANT]
22-
> MCP's transport layer handles communication between clients and servers.
23-
> The Swift SDK supports multiple transport mechanisms,
24-
> with different platform availability:
25-
>
26-
> * `StdioTransport` is available on Apple platforms
27-
> and Linux distributions with glibc, such as
28-
> Ubuntu, Debian, Fedora, CentOS, or RHEL.
29-
>
30-
> * `NetworkTransport` is available only on Apple platforms.
16+
17+
### Transports and Platform Availability
18+
19+
MCP's transport layer handles communication between clients and servers.
20+
The Swift SDK provides multiple built-in transports:
21+
22+
- [`StdioTransport`](/Sources/MCP/Base/Transports/StdioTransport.swift):
23+
Implements [stdio](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio) transport.
24+
Available on Apple platforms
25+
and Linux distributions with glibc (Ubuntu, Debian, Fedora, CentOS, RHEL).
26+
- [`HTTPClientTransport`](/Sources/MCP/Base/Transports/HTTPClientTransport.swift):
27+
Implements [Streamable HTTP transport](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http)
28+
using Foundation [URL Loading System](https://developer.apple.com/documentation/foundation/url-loading-system)
29+
- [`NetworkTransport`](/Sources/MCP/Base/Transports/NetworkTransport.swift):
30+
Implements custom transport over TCP and UDP
31+
using Apple's [Networking framework](https://developer.apple.com/documentation/network).
32+
Available exclusively on Apple platforms.
33+
34+
While the core library works on any platform supporting Swift 6
35+
(including Linux and Windows),
36+
running a client or server requires a compatible transport.
37+
You can implement a custom transport for platforms without built-in support.
38+
39+
For custom transport implementation details,
40+
see the [`Transport` protocol](/Sources/MCP/Base/Transport.swift).
3141

3242
## Installation
3343

0 commit comments

Comments
 (0)