- Add OpenAPI Generator to build system to automatically generate MCP protocol data classes from the official schema. - Configure code quality tools to exclude generated files - Add deserialization test ## Motivation and Context Writing classes by hand is error-prone, when json schema exists. See #185, Also, autogenerating model classes ensures the SDK is in sync with the protocol and can quickly catch up with its changes (see #218) ## How Has This Been Tested? Regression tests ## Breaking Changes No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] 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 - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions -->
140 lines
4.1 KiB
Kotlin
140 lines
4.1 KiB
Kotlin
@file:OptIn(ExperimentalWasmDsl::class)
|
|
|
|
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateTask
|
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
|
import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask
|
|
|
|
plugins {
|
|
id("mcp.multiplatform")
|
|
id("mcp.publishing")
|
|
id("mcp.dokka")
|
|
alias(libs.plugins.kotlinx.binary.compatibility.validator)
|
|
id("org.openapi.generator") version "7.15.0"
|
|
}
|
|
|
|
tasks.withType<KotlinCompilationTask<*>>().configureEach {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
tasks.named("runKtlintCheckOverCommonMainSourceSet") {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
// Also ensure it runs before other relevant tasks
|
|
tasks.withType<DokkaGenerateTask>().configureEach {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
tasks.withType<Task>().configureEach {
|
|
if (name.lowercase().contains("sourcesjar")) {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
}
|
|
|
|
openApiGenerate {
|
|
val schemaVersion = "2025-03-26" // or "2025-06-18" or "draft"
|
|
val schemaUrl =
|
|
// "https://raw.githubusercontent.com/modelcontextprotocol/modelcontextprotocol/refs/heads/main/schema/$schemaVersion/schema.json"
|
|
"https://raw.githubusercontent.com/modelcontextprotocol/modelcontextprotocol/refs/tags/$schemaVersion/schema/$schemaVersion/schema.json"
|
|
generatorName = "kotlin"
|
|
remoteInputSpec = schemaUrl
|
|
packageName = "io.modelcontextprotocol.kotlin.sdk.models"
|
|
modelPackage = "io.modelcontextprotocol.kotlin.sdk.models"
|
|
apiPackage = "io.modelcontextprotocol.kotlin.sdk.api"
|
|
generateModelTests = false
|
|
generateModelDocumentation = false
|
|
cleanupOutput = false
|
|
skipValidateSpec = true // do not validate spec
|
|
library = "multiplatform"
|
|
ignoreFileOverride = "${layout.projectDirectory}/.openapi-generator-ignore"
|
|
globalProperties.set(
|
|
mapOf(
|
|
"supportingFiles" to "",
|
|
"models" to "", // or generate all models
|
|
),
|
|
)
|
|
configOptions.set(
|
|
mapOf(
|
|
"omitGradleWrapper" to "true",
|
|
"enumPropertyNaming" to "UPPERCASE",
|
|
"dateLibrary" to "kotlinx-datetime",
|
|
"explicitApi" to "true",
|
|
"modelMutable" to "false",
|
|
),
|
|
)
|
|
}
|
|
|
|
// Generation library versions
|
|
val generateLibVersion by tasks.registering {
|
|
val outputDir = layout.buildDirectory.dir("generated-sources/libVersion")
|
|
outputs.dir(outputDir)
|
|
|
|
// Capture version at configuration time to avoid configuration cache issues
|
|
val projectVersion = project.version.toString()
|
|
|
|
doLast {
|
|
val sourceFile = outputDir.get().file("io/modelcontextprotocol/kotlin/sdk/LibVersion.kt").asFile
|
|
sourceFile.parentFile.mkdirs()
|
|
sourceFile.writeText(
|
|
"""
|
|
package io.modelcontextprotocol.kotlin.sdk
|
|
|
|
public const val LIB_VERSION: String = "$projectVersion"
|
|
|
|
""".trimIndent(),
|
|
)
|
|
}
|
|
}
|
|
|
|
kotlin {
|
|
iosArm64()
|
|
iosX64()
|
|
iosSimulatorArm64()
|
|
watchosX64()
|
|
watchosArm64()
|
|
watchosSimulatorArm64()
|
|
tvosX64()
|
|
tvosArm64()
|
|
tvosSimulatorArm64()
|
|
js {
|
|
browser()
|
|
nodejs()
|
|
}
|
|
wasmJs {
|
|
browser()
|
|
nodejs()
|
|
}
|
|
|
|
sourceSets {
|
|
commonMain {
|
|
kotlin.srcDir(generateLibVersion)
|
|
kotlin.srcDir("build/generate-resources/main/src/commonMain/kotlin")
|
|
dependencies {
|
|
api(libs.kotlinx.serialization.json)
|
|
api(libs.kotlinx.coroutines.core)
|
|
api(libs.kotlinx.io.core)
|
|
api(libs.ktor.server.websockets)
|
|
api(libs.kotlinx.collections.immutable)
|
|
implementation(libs.kotlin.logging)
|
|
}
|
|
}
|
|
|
|
commonTest {
|
|
dependencies {
|
|
implementation(kotlin("test"))
|
|
implementation(libs.kotest.assertions.core)
|
|
implementation(libs.kotest.assertions.json)
|
|
}
|
|
}
|
|
|
|
jvmTest {
|
|
dependencies {
|
|
runtimeOnly(libs.slf4j.simple)
|
|
}
|
|
}
|
|
|
|
wasmJsMain.dependencies {
|
|
api(libs.kotlinx.coroutines.core.wasm) // workaround for wasm server
|
|
}
|
|
}
|
|
}
|