Add examples and bundler
This commit is contained in:
51
README.md
Normal file
51
README.md
Normal file
@@ -0,0 +1,51 @@
|
||||
### Building the project
|
||||
|
||||
To build the project and generate the fat JAR and binaries, run:
|
||||
```bash
|
||||
mvn clean package
|
||||
```
|
||||
|
||||
### Generated Artifacts
|
||||
|
||||
After a successful build, you can find the following artifacts in the `target/` directory:
|
||||
- `mcp-server-app-all.jar`: Executable fat JAR containing all dependencies.
|
||||
- `mcp-server-app`: Linux executable wrapper script.
|
||||
- `mcp-server-app.exe`: Windows executable (console application).
|
||||
|
||||
### Running the server
|
||||
|
||||
Using the fat JAR:
|
||||
```bash
|
||||
java -jar target/mcp-server-app-all.jar
|
||||
```
|
||||
|
||||
Using the Linux executable:
|
||||
```bash
|
||||
./target/mcp-server-app
|
||||
```
|
||||
|
||||
The server will start on port `8080`.
|
||||
|
||||
### MCP Configuration
|
||||
This server is available using
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"test": {
|
||||
"command": "java",
|
||||
"args": ["-jar", "/path/to/mcp-server-app-all.jar"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
or via HTTP:
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"test": {
|
||||
"url": "http://127.0.0.1:8080/mcp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
as mcp config.
|
||||
Reference in New Issue
Block a user