add missing KDoc comments for public classes, interfaces, and properties

Author: devcrocod

config/detekt/detekt.yml

@@ -23,6 +23,13 @@ empty-blocks:
     excludes: *testFolders
 
 comments:
+    UndocumentedPublicClass:
+      active: true
+      excludes: [ '**/test/**', '**/commonTest/**', '**/jvmTest/**', '**/generated-sources/**' ]
+      ignoreDefaultCompanionObject: true
+    UndocumentedPublicFunction:
+      active: true
+      excludes: [ '**/test/**', '**/commonTest/**', '**/jvmTest/**', '**/generated-sources/**' ]
     UndocumentedPublicProperty:
       active: true
       excludes: [ '**/test/**', '**/commonTest/**', '**/jvmTest/**', '**/generated-sources/**' ]

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/Protocol.kt

@@ -100,9 +100,13 @@ public class RequestOptions(
     public val onProgress: ProgressCallback? = null,
     public val timeout: Duration = DEFAULT_REQUEST_TIMEOUT,
 ) : TransportSendOptions(relatedRequestId, resumptionToken, onResumptionToken) {
+    /** Destructuring component for [onProgress]. */
     public operator fun component4(): ProgressCallback? = onProgress
+
+    /** Destructuring component for [timeout]. */
     public operator fun component5(): Duration = timeout
 
+    /** Creates a copy of this [RequestOptions] with the specified fields replaced. */
     public fun copy(
         relatedRequestId: RequestId? = this.relatedRequestId,
         resumptionToken: String? = this.resumptionToken,

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/TransportSendOptions.kt

@@ -17,10 +17,16 @@ public open class TransportSendOptions(
     public val resumptionToken: String? = null,
     public val onResumptionToken: ((String) -> Unit)? = null,
 ) {
+    /** Destructuring component for [relatedRequestId]. */
     public operator fun component1(): RequestId? = relatedRequestId
+
+    /** Destructuring component for [resumptionToken]. */
     public operator fun component2(): String? = resumptionToken
+
+    /** Destructuring component for [onResumptionToken]. */
     public operator fun component3(): ((String) -> Unit)? = onResumptionToken
 
+    /** Creates a copy of this [TransportSendOptions] with the specified fields replaced. */
     public open fun copy(
         relatedRequestId: RequestId? = this.relatedRequestId,
         resumptionToken: String? = this.resumptionToken,

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types/content.kt

@@ -41,6 +41,9 @@ public sealed interface ContentBlock : WithMeta {
     public val type: ContentTypes
 }
 
+/**
+ * Content block that carries media data such as text, images, or audio.
+ */
 @Serializable(with = MediaContentPolymorphicSerializer::class)
 public sealed interface MediaContent : ContentBlock
 

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types/jsonRpc.kt

@@ -112,6 +112,9 @@ public sealed interface JSONRPCMessage {
     public val jsonrpc: String
 }
 
+/**
+ * Represents an empty JSON-RPC message used as a placeholder or no-op response.
+ */
 @Serializable
 public data object JSONRPCEmptyMessage : JSONRPCMessage {
     override val jsonrpc: String = JSONRPC_VERSION

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types/request.kt

@@ -49,6 +49,9 @@ public value class RequestMeta(public val json: JsonObject) {
     public operator fun get(key: String): JsonElement? = json[key]
 }
 
+/**
+ * Base interface for parameters attached to a [Request].
+ */
 @Serializable
 public sealed interface RequestParams {
     /**
@@ -61,6 +64,9 @@ public sealed interface RequestParams {
     public val meta: RequestMeta?
 }
 
+/**
+ * Default [RequestParams] implementation carrying only optional metadata.
+ */
 @Serializable
 public data class BaseRequestParams(@SerialName("_meta") override val meta: RequestMeta? = null) : RequestParams
 
@@ -121,9 +127,15 @@ public sealed interface PaginatedRequest : Request {
 @Serializable(with = RequestResultPolymorphicSerializer::class)
 public sealed interface RequestResult : WithMeta
 
+/**
+ * Represents a result returned by the server in response to a [ClientRequest].
+ */
 @Serializable(with = ClientResultPolymorphicSerializer::class)
 public sealed interface ClientResult : RequestResult
 
+/**
+ * Represents a result returned by the client in response to a [ServerRequest].
+ */
 @Serializable(with = ServerResultPolymorphicSerializer::class)
 public sealed interface ServerResult : RequestResult
 

kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types/resources.kt

@@ -8,6 +8,9 @@ import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.JsonObject
 
+/**
+ * Common interface for resource-like types that share URI, name, and description fields.
+ */
 @Serializable
 public sealed interface ResourceLike : WithMeta