Spring Bitcoin MCP Server

🚀 Bitcoin MCP Server

This project provides a Model Context Protocol (MCP) server for Bitcoin price information.

🚀 Quick Start

📦 Installation

To build the project, run the following command:

mvn clean package

This will create a JAR file at target/bitcoinmcp-0.0.1-SNAPSHOT.jar.

💻 Usage Examples

Basic Usage

The server is configured to communicate using Standard Input Output (STDIO). You can view the specific information in the application.yaml file.

The project includes a test client (ClientSTDIO) that demonstrates how to connect to the MCP server.

Why does ClientSTDIO need to see the server JAR file?

The ClientSTDIO class uses the Model Context Protocol (MCP) client library to communicate with the MCP server. It needs to reference the server JAR file because:

1. The MCP client uses a subprocess mechanism to start the server.
2. It starts the server by executing the JAR file as a separate Java process.
3. The client and the server communicate via Standard Input Output (STDIO).

This architecture allows the client to interact with the server without manually starting the server or exposing network ports. However, it means that the client needs to know the location of the server JAR file.

Configuring the JAR file path

The client needs to know the location of the JAR file. There are three ways to specify it:

1. System Property:

java -Dmcp.server.jar.path=/path/to/bitcoinmcp-0.0.1-SNAPSHOT.jar -cp target/test-classes za.sk.bitconmcp.ClientSTDIO

2. Environment Variable:

export MCP_SERVER_JAR_PATH=/path/to/bitcoinmcp-0.0.1-SNAPSHOT.jar
java -cp target/test-classes za.sk.bitconmcp.ClientSTDIO

3. Default Path: If neither the system property nor the environment variable is set, the client will look for the JAR file at target/bitcoinmcp-0.0.1-SNAPSHOT.jar relative to the current working directory.

Running the client

To run the client, use Maven's exec plugin to ensure that all dependencies are included in the classpath:

# Make sure you are in the project root directory
cd /opt/mcp/server/bitcoinmcp

# Run the client using Maven
mvn exec:java -Dexec.classpathScope=test -Dexec.mainClass="za.sk.bitconmcp.ClientSTDIO"

You can also specify the absolute path of the JAR file:

mvn exec:java -Dexec.classpathScope=test -Dexec.mainClass="za.sk.bitconmcp.ClientSTDIO" -Dmcp.server.jar.path=/path/to/bitcoinmcp-0.0.1-SNAPSHOT.jar

The client will:

1. Connect to the MCP server.
2. List the available tools.
3. Call the getBitcoinProceByCurrency tool, using USD as the currency.
4. Display the result.
5. Close the connection.

🔧 Troubleshooting

If you see the error "MCP server JAR file not found", make sure that:

1. You have built the project using mvn clean package.
2. You are running the client from the correct directory.
3. The JAR file path is correctly configured.

You can also specify the absolute path of the JAR file using one of the above configuration methods.