diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f586c9cd..c16a07ea 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -43,6 +43,18 @@ jobs: - name: Run tests run: swift test -v + documentation: + name: Documentation + runs-on: macos-latest + timeout-minutes: 10 + steps: + - uses: actions/checkout@v4 + - uses: swift-actions/setup-swift@v2 + with: + swift-version: "6.1.0" + - name: Build Documentation + run: swift package generate-documentation --target MCP --warnings-as-errors + static-linux-sdk-build: name: Linux Static SDK Build (${{ matrix.swift-version }} - ${{ matrix.os }}) strategy: diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 00000000..db50c139 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,4 @@ +version: 1 +builder: + configs: + - documentation_targets: [MCP] diff --git a/Package.resolved b/Package.resolved index 5e9023c5..6183e4dd 100644 --- a/Package.resolved +++ b/Package.resolved @@ -1,15 +1,33 @@ { - "originHash" : "08de61941b7919a65e36c0e34f8c1c41995469b86a39122158b75b4a68c4527d", + "originHash" : "351612f74fc8f7ddb0a7aeaf0a96bc12c0b5173a8981f1fd181790aba44836dd", "pins" : [ { "identity" : "eventsource", "kind" : "remoteSourceControl", - "location" : "https://github.com/loopwork-ai/eventsource.git", + "location" : "https://github.com/mattt/eventsource.git", "state" : { "revision" : "e83f076811f32757305b8bf69ac92d05626ffdd7", "version" : "1.1.0" } }, + { + "identity" : "swift-docc-plugin", + "kind" : "remoteSourceControl", + "location" : "https://github.com/swiftlang/swift-docc-plugin", + "state" : { + "revision" : "3e4f133a77e644a5812911a0513aeb7288b07d06", + "version" : "1.4.5" + } + }, + { + "identity" : "swift-docc-symbolkit", + "kind" : "remoteSourceControl", + "location" : "https://github.com/swiftlang/swift-docc-symbolkit", + "state" : { + "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34", + "version" : "1.0.0" + } + }, { "identity" : "swift-log", "kind" : "remoteSourceControl", diff --git a/Package.swift b/Package.swift index 064e0d87..a2d2e9ef 100644 --- a/Package.swift +++ b/Package.swift @@ -8,6 +8,7 @@ var dependencies: [Package.Dependency] = [ .package(url: "https://github.com/apple/swift-system.git", from: "1.0.0"), .package(url: "https://github.com/apple/swift-log.git", from: "1.5.0"), .package(url: "https://github.com/mattt/eventsource.git", from: "1.1.0"), + .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"), ] // Target dependencies needed on all platforms diff --git a/Package@swift-6.0.swift b/Package@swift-6.0.swift index 5fdf2e49..e04020b6 100644 --- a/Package@swift-6.0.swift +++ b/Package@swift-6.0.swift @@ -8,6 +8,7 @@ var dependencies: [Package.Dependency] = [ .package(url: "https://github.com/apple/swift-system.git", from: "1.0.0"), .package(url: "https://github.com/apple/swift-log.git", from: "1.5.0"), .package(url: "https://github.com/mattt/eventsource.git", from: "1.1.0"), + .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"), ] // Target dependencies needed on all platforms diff --git a/Sources/MCP/Client/Client.swift b/Sources/MCP/Client/Client.swift index 696ffd14..9bca2f5d 100644 --- a/Sources/MCP/Client/Client.swift +++ b/Sources/MCP/Client/Client.swift @@ -343,7 +343,7 @@ public actor Client { /// A batch of requests. /// /// Objects of this type are passed as an argument to the closure - /// of the ``Client/withBatch(_:)`` method. + /// of the ``Client/withBatch(body:)`` method. public actor Batch { unowned let client: Client var requests: [AnyRequest] = []