Add module documentation and enhance Dokka configuration #261

kpavlov · 2025-09-12T06:44:43Z

#252 Add module documentation and enhance Dokka configuration

How Has This Been Tested?

./gradlew :docs:dokkaGenerate

Changes

Add workflow to build and publish API documentation with Dokka
- Introduce .github/workflows/apidocs.yaml to build and deploy API docs on main and release events.
- Configure Gradle for Dokka builds and update project dependencies.
- Include :docs module in project settings.
Introduce Module.md for kotlin-sdk-server, kotlin-sdk-client, and kotlin-sdk-core modules.
Update .gitignore to include .idea/icon.png and add placeholder icon files
Remove outdated documentation HTML files

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update

Checklist

I have read the MCP Documentation
My code follows the repository's style guidelines
New and existing tests pass locally
I have added appropriate error handling
I have added or updated documentation as needed

Additional context

devcrocod

I have some questions about this pr, could you please take a look at them?

Also, have you explored documentation versioning? And how could it work with gh actions?

devcrocod · 2025-09-12T10:40:06Z

settings.gradle.kts

+    ":kotlin-sdk-server",
+    ":kotlin-sdk",
+    ":kotlin-sdk-test",
+    ":docs",


why make a separate docs module?

because it has to define dependencies for dokka to compile site for multimodule project

You can do this in :kotlin-sdk without creating a new module

I would prefer a separate docs module to have a place for assets and custom docs in the future

devcrocod · 2025-09-12T10:42:17Z

.github/workflows/apidocs.yaml

+        with:
+          path: docs/build/dokka/html
+
+      - name: Deploy to GitHub Pages


Do I understand correctly that the deploy will be from github actions instead of main/docs?

yes. But I can test it only once workflow is merged to default branch

devcrocod · 2025-09-12T10:44:15Z

.idea/icon.png

How and where is this icon used? Why add it to .idea if it’s already in docs/icon?

it is visible here:

devcrocod · 2025-09-12T10:45:31Z

buildSrc/src/main/kotlin/mcp.dokka.gradle.kts

+        includes.from("Module.md")
+
+        pluginsConfiguration.html {
+            footerMessage = "Copyright © 2024-2025 Anthropic, PBC"


Maybe we should change the copyright, for example like in C#?

This is a question, but not to me :) I took it from here for consistency.

Yea, I understand
it's a general question, mb we should change it in License as well

buildSrc/src/main/kotlin/mcp.dokka.gradle.kts

kotlin-sdk-client/Module.md

kotlin-sdk-server/Module.md

devcrocod · 2025-09-12T11:08:39Z

docs/icon.png

This icon is not used in any way.
I also don’t understand why it’s necessary

I wanted to include it as a logo in apidocs

No need, it should be kotlin or jb+kotlin logo

kpavlov · 2025-09-12T11:47:57Z

Also, have you explored documentation versioning?

I did not explore document versioning yet. Thank you for the link, but let's implement it in another PR

devcrocod · 2025-09-12T11:50:21Z

I did not explore document versioning yet. Thank you for the link, but let's implement it in another PR

sure
But it seems to me that with versioning, deploying the documentation from actions won’t work

kpavlov · 2025-09-15T14:56:05Z

.github/workflows/apidocs.yaml


      - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@ed408507eac070d1f99cc633dbcf757c94c7933a # v4.4.3
+        uses: gradle/actions/setup-gradle@v4


Docker image pinning is actually recommended for security reasons.
We can skip it today since the Renovate is not configured.
https://docs.renovatebot.com/docker/#digest-pinning
https://docs.renovatebot.com/modules/manager/github-actions/#digest-pinning-and-updating

kpavlov · 2025-09-15T14:58:33Z

.github/workflows/apidocs.yaml

-  push:
-    branches: [ "main" ]


Now, documentation is never built automatically

no, it will build automatically by release or manually
If the documentation is published on push, it means it will not match sdk from maven central

- Add workflow to build and publish API documentation with Dokka - Introduce `.github/workflows/apidocs.yaml` to build and deploy API docs on `main` and release events. - Configure Gradle for Dokka builds and update project dependencies. - Include `:docs` module in project settings. - Introduce `Module.md` for `kotlin-sdk-server`, `kotlin-sdk-client`, and `kotlin-sdk-core` modules. - Update `.gitignore` to include `.idea/icon.png` and add placeholder icon files - Remove outdated documentation HTML files

…ol/kotlin-sdk/blob/main/LICENSE

- remove docs gradle module - remove trigger docs on push - add main page for dokka documentation

| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [io.modelcontextprotocol:kotlin-sdk-server](https://github.com/modelcontextprotocol/kotlin-sdk) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `0.7.0` -> `0.7.1` | | [io.modelcontextprotocol:kotlin-sdk-core](https://github.com/modelcontextprotocol/kotlin-sdk) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `0.7.0` -> `0.7.1` | | [com.autonomousapps.dependency-analysis](https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin) | plugin | misk/gradle/libs.versions.toml | gradle | patch | `3.0.2` -> `3.0.3` | | [software.amazon.awssdk:sdk-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:sqs](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:s3](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:regions](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:dynamodb-enhanced](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:dynamodb](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:aws-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:bom](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | | [software.amazon.awssdk:auth](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.33.9` -> `2.33.10` | --- ### Release Notes <details> <summary>modelcontextprotocol/kotlin-sdk (io.modelcontextprotocol:kotlin-sdk-server)</summary> ### [`v0.7.1`](https://github.com/modelcontextprotocol/kotlin-sdk/releases/tag/0.7.1) [Compare Source](modelcontextprotocol/kotlin-sdk@0.7.0...0.7.1) ##### What's Changed - Bump io.github.oshai:kotlin-logging from 7.0.7 to 7.0.11 by [@dependabot](https://github.com/dependabot)\[bot] in [#211](modelcontextprotocol/kotlin-sdk#211) - Bump org.jlleitschuh.gradle.ktlint from 13.0.0 to 13.1.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#241](modelcontextprotocol/kotlin-sdk#241) - Bump com.anthropic:anthropic-java from 0.8.0 to 2.6.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#246](modelcontextprotocol/kotlin-sdk#246) - Fix upload reports in GitHub actions by [@skarpovdev](https://github.com/skarpovdev) in [#264](modelcontextprotocol/kotlin-sdk#264) - Bump ktor from 3.2.3 to 3.3.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#265](modelcontextprotocol/kotlin-sdk#265) - fix hang caused by StreamableHttpClientTransport ([#226](modelcontextprotocol/kotlin-sdk#226)) by [@AdrianMiska](https://github.com/AdrianMiska) in [#227](modelcontextprotocol/kotlin-sdk#227) - Bump kotlin from 2.2.0 to 2.2.10 by [@dependabot](https://github.com/dependabot)\[bot] in [#230](modelcontextprotocol/kotlin-sdk#230) - Add module documentation and enhance Dokka configuration by [@kpavlov](https://github.com/kpavlov) in [#261](modelcontextprotocol/kotlin-sdk#261) - Mark `testMultipleClientParallel` as ignored due to flakiness by [@devcrocod](https://github.com/devcrocod) in [#267](modelcontextprotocol/kotlin-sdk#267) ##### New Contributors - [@AdrianMiska](https://github.com/AdrianMiska) made their first contribution in [#227](modelcontextprotocol/kotlin-sdk#227) **Full Changelog**: <modelcontextprotocol/kotlin-sdk@0.7.0...0.7.1> </details> <details> <summary>autonomousapps/dependency-analysis-android-gradle-plugin (com.autonomousapps.dependency-analysis)</summary> ### [`v3.0.3`](https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin/blob/HEAD/CHANGELOG.md#Version-303) - \[Fix]: compare versions via `VersionNumber`, not raw strings. - \[Fix] Forcibly downgrade kotlin-stdlib to 2.0.21 for Gradle 8.11 support. </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: 5f728b0acc73a9742f56946b97f85ad1e3355442

…tprotocol#261) ## modelcontextprotocol#252 Add module documentation and enhance Dokka configuration ## How Has This Been Tested? `./gradlew :docs:dokkaGenerate` ## Changes - Add workflow to build and publish API documentation with Dokka - Introduce `.github/workflows/apidocs.yaml` to build and deploy API docs on `main` and release events. - Configure Gradle for Dokka builds and update project dependencies. - Include `:docs` module in project settings. - Introduce `Module.md` for `kotlin-sdk-server`, `kotlin-sdk-client`, and `kotlin-sdk-core` modules. - Update `.gitignore` to include `.idea/icon.png` and add placeholder icon files - Remove outdated documentation HTML files ## Types of changes  - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist  - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Additional context  --------- Co-authored-by: devcrocod <devcrocod@gmail.com>

kpavlov added the documentation Improvements or additions to documentation label Sep 12, 2025

kpavlov requested a review from devcrocod September 12, 2025 06:46

kpavlov marked this pull request as ready for review September 12, 2025 06:51

kpavlov requested review from e5l and tiginamaria and removed request for e5l September 12, 2025 06:51

kpavlov force-pushed the kpavlov/apidocs branch from bb4f51b to 9da7aa5 Compare September 12, 2025 07:51

kpavlov requested review from e5l and aozherelyeva September 12, 2025 09:55

devcrocod reviewed Sep 12, 2025

View reviewed changes

kpavlov force-pushed the kpavlov/apidocs branch from 14ae8cd to d59877a Compare September 12, 2025 11:42

e5l previously approved these changes Sep 15, 2025

View reviewed changes

devcrocod force-pushed the kpavlov/apidocs branch from d59877a to 0117233 Compare September 15, 2025 12:12

devcrocod dismissed e5l’s stale review via d027469 September 15, 2025 14:29

devcrocod requested a review from e5l September 15, 2025 14:30

devcrocod force-pushed the kpavlov/apidocs branch from d027469 to 12160b9 Compare September 15, 2025 14:52

kpavlov commented Sep 15, 2025

View reviewed changes

kpavlov and others added 4 commits September 15, 2025 17:27

Align copyright in apidocs with https://github.com/modelcontextprotoc…

664b110

…ol/kotlin-sdk/blob/main/LICENSE

address PR comments

d5981d0

Refactor dokka configuration

b7e551a

- remove docs gradle module - remove trigger docs on push - add main page for dokka documentation

devcrocod force-pushed the kpavlov/apidocs branch from 12160b9 to b7e551a Compare September 15, 2025 15:27

tiginamaria approved these changes Sep 15, 2025

View reviewed changes

devcrocod merged commit 557bc5e into main Sep 15, 2025
4 checks passed

devcrocod deleted the kpavlov/apidocs branch September 15, 2025 15:44

Add module documentation and enhance Dokka configuration #261

Add module documentation and enhance Dokka configuration #261

Uh oh!

Conversation

kpavlov commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

#252 Add module documentation and enhance Dokka configuration

How Has This Been Tested?

Changes

Types of changes

Checklist

Additional context

Uh oh!

devcrocod left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpavlov commented Sep 12, 2025

Uh oh!

devcrocod commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devcrocod Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kpavlov commented Sep 12, 2025 •

edited

Loading

devcrocod commented Sep 12, 2025 •

edited

Loading

devcrocod Sep 15, 2025 •

edited

Loading