| Filename | Latest commit message | Latest commit date |
|---|---|---|
f462019c43Add test for sse server TODO: Add tests for the other protocols <!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## 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) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [x] Tests ## 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) - [x] My code follows the repository's style guidelines - [x] 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 --> |
||
| .. | ||
| gradle | ||
| src | ||
| build.gradle.kts | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| README.md | ||
| settings.gradle.kts | ||
MCP Kotlin Server Sample
A sample implementation of an MCP (Model Context Protocol) server in Kotlin that demonstrates different server configurations and transport methods.
Features
- Multiple server operation modes:
- Standard I/O server
- SSE (Server-Sent Events) server with plain configuration
- SSE server using Ktor plugin
- Built-in capabilities for:
- Prompts management
- Resources handling
- Tools integration
Getting Started
Running the Server
The server defaults to SSE mode with Ktor plugin on port 3001. You can customize the behavior using command-line arguments.
Default (SSE with Ktor plugin):
./gradlew run
Standard I/O mode:
./gradlew run --args="--stdio"
SSE with plain configuration:
./gradlew run --args="--sse-server 3001"
SSE with Ktor plugin (custom port):
./gradlew run --args="--sse-server-ktor 3002"
Connecting to the Server
For SSE servers:
- Start the server
- Use the MCP inspector to connect to
http://localhost:<port>/sse
For STDIO servers:
- Connect using an MCP client that supports STDIO transport
Server Capabilities
- Prompts: Supports prompt management with list change notifications
- Resources: Includes subscription support and list change notifications
- Tools: Supports tool management with list change notifications
Implementation Details
The server is implemented using:
- Ktor for HTTP server functionality (SSE modes)
- Kotlin coroutines for asynchronous operations
- SSE for real-time communication in web contexts
- Standard I/O for command-line interface and process-based communication
Example Capabilities
The sample server demonstrates:
- Prompt: "Kotlin Developer" - helps develop small Kotlin applications with a configurable project name
- Tool: "kotlin-sdk-tool" - a simple test tool that returns a greeting
- Resource: "Web Search" - a placeholder resource demonstrating resource handling