This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr-mcp.git
The following commit(s) were added to refs/heads/main by this push:
new f9668e2 docs: enhance README with comprehensive STDIO and HTTP mode
setup instructions (#16)
f9668e2 is described below
commit f9668e24482740b43371478c14b2f82c47738cca
Author: Aditya Parikh <[email protected]>
AuthorDate: Tue Nov 4 20:59:11 2025 -0500
docs: enhance README with comprehensive STDIO and HTTP mode setup
instructions (#16)
---
README.md | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 89 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index ff22f3b..5ce5e41 100644
--- a/README.md
+++ b/README.md
@@ -21,21 +21,35 @@ A Spring AI Model Context Protocol (MCP) server that
provides tools for interact
docker compose up -d
```
- Run the server:
- - Option A (JAR):
- ```bash
- ./gradlew build
- java -jar build/libs/solr-mcp-0.0.1-SNAPSHOT.jar
- ```
- - Option B (Docker):
- ```bash
- docker run -i --rm ghcr.io/apache/solr-mcp:latest
- ```
-
-For more ways to run (HTTP mode, custom SOLR_URL, Linux host networking) see
the Deployment Guide: docs/DEPLOYMENT.md
+ - **STDIO mode (default)**:
+ - JAR:
+ ```bash
+ ./gradlew build
+ java -jar build/libs/solr-mcp-0.0.1-SNAPSHOT.jar
+ ```
+ - Docker:
+ ```bash
+ docker run -i --rm ghcr.io/apache/solr-mcp:latest
+ ```
+ - **HTTP mode**:
+ - JAR:
+ ```bash
+ PROFILES=http java -jar build/libs/solr-mcp-0.0.1-SNAPSHOT.jar
+ ```
+ - Docker:
+ ```bash
+ docker run -p 8080:8080 --rm -e PROFILES=http
ghcr.io/apache/solr-mcp:latest
+ ```
+
+For more options (custom SOLR_URL, Linux host networking) see the Deployment
Guide: docs/DEPLOYMENT.md
### Claude Desktop
Add this to your Claude Desktop config (macOS path shown); then restart Claude.
+
+**STDIO mode (default)**
+
+Using Docker:
```json
{
"mcpServers": {
@@ -50,6 +64,70 @@ Add this to your Claude Desktop config (macOS path shown);
then restart Claude.
}
```
+Using JAR:
+
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "command": "java",
+ "args": [
+ "-jar",
+ "/absolute/path/to/solr-mcp-0.0.1-SNAPSHOT.jar"
+ ],
+ "env": {
+ "SOLR_URL": "http://localhost:8983/solr/";
+ }
+ }
+ }
+}
+```
+
+**HTTP mode**
+
+Using Docker:
+
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "command": "docker",
+ "args": [
+ "run",
+ "-p",
+ "8080:8080",
+ "--rm",
+ "ghcr.io/apache/solr-mcp:latest"
+ ],
+ "env": {
+ "PROFILES": "http",
+ "SOLR_URL": "http://localhost:8983/solr/";
+ }
+ }
+ }
+}
+```
+
+Using JAR:
+
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "command": "java",
+ "args": [
+ "-jar",
+ "/absolute/path/to/solr-mcp-0.0.1-SNAPSHOT.jar"
+ ],
+ "env": {
+ "PROFILES": "http",
+ "SOLR_URL": "http://localhost:8983/solr/";
+ }
+ }
+ }
+}
+```
+
More configuration options: docs/DEPLOYMENT.md#docker-images-with-jib
## Available MCP tools
