| Filename | Latest commit message | Latest commit date |
|---|---|---|
Users currently must manually `install(ContentNegotiation) {
json(McpJson) }` before calling `mcp()`,
`mcpStreamableHttp()`, or `mcpStatelessStreamableHttp()`. Forgetting
this or using the default `json()`
instead of `json(McpJson)` causes silent serialization failures at
runtime (e.g., explicit null fields in JSON-RPC
responses). This PR makes the SDK install it automatically.
Fixes #664
## Changes
- **Core feature** — `mcp()`, `mcpStreamableHttp()`, and
`mcpStatelessStreamableHttp()` now auto-install `ContentNegotiation`
configured with `McpJson`. If the user already installed
`ContentNegotiation`, a warning is logged instead of crashing with
`DuplicatePluginException`.
- **`KtorServerHelpers.kt`** (new) — `installMcpContentNegotiation()`
internal helper with `pluginOrNull` guard and warning
- **`KtorServer.kt`** — calls the helper from all three entry points
- **`build.gradle.kts`** — adds `ktor-server-content-negotiation` and
`ktor-serialization` as `implementation` deps to `kotlin-sdk-server`
- **Removed manual installs** from `ConformanceServer.kt` and
`AbstractStreamableHttpIntegrationTest.kt`.
- **Test infrastructure** — replaced `slf4j-simple` with Logback and use
`ListAppender` (`LogCapture` utility) for deterministic log assertion.
Added `logback-test.xml` matching previous log levels.
- **`StreamableHttpServerConfigurationTest.kt`** (new) — verifies the
warning for all three entry points: `mcpStreamableHttp`,
`mcpStatelessStreamableHttp`, and `mcp` (SSE).
- **README.md** — removed manual `ContentNegotiation` boilerplate from
examples, documented automatic installation, added CORS configuration
snippet for browser-based clients.
- **CI** — added `ktlintCheck` to the Linux build matrix job.
## How Has This Been Tested?
Unit/integration tests. Conformance tests updated
## Breaking Changes
No
## Types of changes
- [x] 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)
- [x] Documentation update
## Checklist
- [x] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [x] My code follows the repository's style guidelines
- [x] New and existing tests pass locally
- [x] I have added appropriate error handling
- [x] I have added or updated documentation as needed
|
||
| .. | ||
| src/main | ||
| .gitignore | ||
| build.gradle.kts | ||
| conformance-baseline.yml | ||
| README.md | ||
| run-conformance.sh | ||
MCP Conformance Tests
Conformance tests for the Kotlin MCP SDK. Uses the external
@modelcontextprotocol/conformance
runner (pinned to 0.1.15) to validate compliance with the MCP specification.
Prerequisites
- JDK 17+
- Node.js 18+ and
npx(for the conformance runner) - curl (used to poll server readiness)
Quick Start
Run all suites (server, client core, client auth) from the project root:
./conformance-test/run-conformance.sh all
Commands
./conformance-test/run-conformance.sh <command> [extra-args...]
| Command | What it does |
|---|---|
list |
List scenarios available in MCP Conformance Test Framework |
server |
Starts the Ktor conformance server, runs the server test suite against it |
client |
Runs the client test suite (initialize, tools_call, elicitation, sse-retry) |
client-auth |
Runs the client auth test suite (20 OAuth scenarios) |
all |
Runs all three suites sequentially |
Any [extra-args] are forwarded to the conformance runner (e.g. --verbose).
What the Script Does
- Builds the module via
./gradlew :conformance-test:installDist - For
server— starts the conformance server onlocalhost:3001, polls until ready - Invokes
npx @modelcontextprotocol/conformance@0.1.15with the appropriate arguments - Saves results to
conformance-test/results/<command>/ - Cleans up the server process on exit
- Exits non-zero if any suite fails
Environment Variables
| Variable | Default | Description |
|---|---|---|
MCP_PORT |
3001 |
Port for the conformance server |
Project Structure
conformance-test/
├── run-conformance.sh # Single entry point script
├── conformance-baseline.yml # Expected failures for known SDK limitations
└── src/main/kotlin/.../conformance/
├── ConformanceServer.kt # Ktor server entry point (StreamableHTTP, DNS rebinding, EventStore)
├── ConformanceClient.kt # Scenario-based client entry point (MCP_CONFORMANCE_SCENARIO routing)
├── ConformanceTools.kt # 18 tool registrations
├── ConformanceResources.kt # 5 resource registrations (static, binary, template, watched, dynamic)
├── ConformancePrompts.kt # 5 prompt registrations (simple, args, image, embedded, dynamic)
├── ConformanceCompletions.kt # completion/complete handler
├── InMemoryEventStore.kt # EventStore impl for SSE resumability (SEP-1699)
└── auth/ # OAuth client for 20 auth scenarios
├── registration.kt # Scenario handler registration
├── utils.kt # Shared utilities: JSON instance, constants, extractOrigin()
├── discovery.kt # Protected Resource Metadata + AS Metadata discovery
├── pkce.kt # PKCE code verifier/challenge generation + AS capability check
├── tokenExchange.kt # Token endpoint interaction (exchange code, error handling)
├── authCodeFlow.kt # Main Authorization Code flow handler (runAuthClient + interceptor)
├── scopeHandling.kt # Scope selection strategy + step-up 403 handling
├── clientRegistration.kt # Client registration logic (pre-reg, CIMD, dynamic)
├── JWTScenario.kt # Client Credentials JWT scenario
├── basicScenario.kt # Client Credentials Basic scenario
└── crossAppAccessScenario.kt # Cross-App Access (SEP-990) scenario
Test Suites
Server Suite
Tests the conformance server against all server scenarios:
| Category | Scenarios |
|---|---|
| Lifecycle | initialize, ping |
| Tools | text, image, audio, embedded, multiple, progress, logging, error, sampling, elicitation, dynamic, reconnection, JSON Schema 2020-12 |
| Resources | list, read-text, read-binary, templates, subscribe, dynamic |
| Prompts | simple, with-args, with-image, with-embedded-resource, dynamic |
| Completions | complete |
| Security | DNS rebinding protection |
Client Core Suite
| Scenario | Description |
|---|---|
initialize |
Connect, list tools, close |
tools_call |
Connect, call add_numbers(a=5, b=3), close |
elicitation-sep1034-client-defaults |
Elicitation with applyDefaults capability |
sse-retry |
Call test_reconnection, verify reconnection |
Client Auth Suite
17 OAuth Authorization Code scenarios + 2 Client Credentials scenarios (jwt, basic) + 1 Cross-App Access scenario = 20 total.
Note
Auth scenarios are implemented using Ktor's
HttpClientplugins (HttpSendinterceptor,ktor-client-auth) as a standalone OAuth client. They do not use the SDK's built-in auth support.
Known SDK Limitations
Scenarios, expected to fail due to current SDK limitations, are tracked in
conformance-baseline.yml.
These failures reveal SDK gaps and are intentionally not fixed in this module.