Update Kotlin-MCP-Server with STDIO support, logging & CORS (#371)
Update Kotlin-MCP-Server with STDIO support, logging & CORS ### Summary - Added support for STDIO transport mode (default behavior). - Configured CORS and migrated SSE server to Ktor's Netty engine. - Redirected logs to `./build/stdout.log` and updated log levels. - New `TestEnvironment` setup for integration testing. - Enhanced documentation with examples for server execution and MCP Inspector usage. - Introduced shadow JAR plugin for building runnable artifacts. ### Motivation and Context Improves server versatility and developer experience by enabling STDIO and refining setup. ## How Has This Been Tested? Unit tests, tested locally (see README.md in sample) **NB! sse plain configuration is not working at the moment** ## Breaking Changes No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [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) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] 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 -->
This commit is contained in:
parent
e4bd866fdd
commit
dc4386f0f1
1 changed files with 172 additions and 69 deletions
|
|
@ -18,40 +18,58 @@ configurations and transport methods.
|
|||
|
||||
### Running the Server
|
||||
|
||||
The server defaults to SSE mode with Ktor plugin on port 3001. You can customize the behavior using command-line arguments.
|
||||
The server defaults [STDIO transport](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#stdio).
|
||||
|
||||
#### Default (SSE with Ktor plugin):
|
||||
You can customize the behavior using command-line arguments.
|
||||
Logs are printed to [./build/stdout.log](./build/stdout.log)
|
||||
|
||||
#### Standard I/O mode (STDIO):
|
||||
|
||||
```bash
|
||||
./gradlew run
|
||||
./gradlew clean build
|
||||
```
|
||||
Use the [MCP inspector](https://modelcontextprotocol.io/docs/tools/inspector)
|
||||
to connect to MCP via STDIO (Click the "▶️ Connect" button):
|
||||
|
||||
#### Standard I/O mode:
|
||||
|
||||
```bash
|
||||
./gradlew run --args="--stdio"
|
||||
```shell
|
||||
npx @modelcontextprotocol/inspector --config mcp-inspector-config.json --server stdio-server
|
||||
```
|
||||
|
||||
#### SSE with plain configuration:
|
||||
|
||||
**NB!: 🐞 This configuration may not work ATM**
|
||||
|
||||
```bash
|
||||
./gradlew run --args="--sse-server 3001"
|
||||
```
|
||||
or
|
||||
```shell
|
||||
./gradlew clean build
|
||||
java -jar ./build/libs/kotlin-mcp-server-0.1.0-all.jar --sse-server 3001
|
||||
```
|
||||
|
||||
#### SSE with Ktor plugin (custom port):
|
||||
Use the [MCP inspector](https://modelcontextprotocol.io/docs/tools/inspector)
|
||||
to connect to `http://localhost:3002/` via SSE Transport (Click the "▶️ Connect" button):
|
||||
```shell
|
||||
npx @modelcontextprotocol/inspector --config mcp-inspector-config.json --server sse-server
|
||||
```
|
||||
|
||||
#### SSE with Ktor plugin:
|
||||
|
||||
```bash
|
||||
./gradlew run --args="--sse-server-ktor 3002"
|
||||
```
|
||||
or
|
||||
```shell
|
||||
./gradlew clean build
|
||||
java -jar ./build/libs/kotlin-mcp-server-0.1.0-all.jar --sse-server-ktor 3002
|
||||
```
|
||||
|
||||
### Connecting to the Server
|
||||
|
||||
For SSE servers:
|
||||
1. Start the server
|
||||
2. Use the [MCP inspector](https://modelcontextprotocol.io/docs/tools/inspector) to connect to `http://localhost:<port>/sse`
|
||||
|
||||
For STDIO servers:
|
||||
- Connect using an MCP client that supports STDIO transport
|
||||
Use the [MCP inspector](https://modelcontextprotocol.io/docs/tools/inspector)
|
||||
to connect to `http://localhost:3002/` via SSE transport (Click the "▶️ Connect" button):
|
||||
```shell
|
||||
npx @modelcontextprotocol/inspector --config mcp-inspector-config.json --server sse-ktor-server
|
||||
```
|
||||
|
||||
## Server Capabilities
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue