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 6e27ca0d docs(clients): standardize STDIO/HTTP/Docker instructions
across client pages (#215)
6e27ca0d is described below
commit 6e27ca0ddfc80a2dc043aed1447fad69954006f4
Author: Aditya Parikh <[email protected]>
AuthorDate: Tue Oct 6 14:21:14 2026 -0400
docs(clients): standardize STDIO/HTTP/Docker instructions across client
pages (#215)
Bring all six MCP client reference pages (Claude Desktop, Claude Code,
Cursor, JetBrains, VS Code, MCP Inspector) to the same structure:
JAR/Docker options as bold labels with the jibDockerBuild build note,
a Linux host-gateway callout after every Docker command, an identical
"Start the Server" snippet in HTTP Mode, and a linked "Secured HTTP
(OAuth2)" section pointing to the Security doc.
Signed-off-by: Aditya Parikh <[email protected]>
Co-authored-by: Claude Sonnet 5 <[email protected]>
---
docs/site/content/pages/mcp/clients/claude-code.md | 22 ++++++++++++++++--
.../content/pages/mcp/clients/claude-desktop.md | 14 +++++++-----
docs/site/content/pages/mcp/clients/cursor.md | 24 ++++++++++++++++++--
docs/site/content/pages/mcp/clients/jetbrains.md | 24 ++++++++++++++++++--
.../content/pages/mcp/clients/mcp-inspector.md | 13 ++++++++++-
docs/site/content/pages/mcp/clients/vs-code.md | 26 ++++++++++++++++++++--
6 files changed, 108 insertions(+), 15 deletions(-)
diff --git a/docs/site/content/pages/mcp/clients/claude-code.md
b/docs/site/content/pages/mcp/clients/claude-code.md
index decf18be..ffa9f6f7 100644
--- a/docs/site/content/pages/mcp/clients/claude-code.md
+++ b/docs/site/content/pages/mcp/clients/claude-code.md
@@ -45,6 +45,8 @@ claude mcp add solr-mcp \
solr-mcp:latest
```
+**Linux users**: add `--add-host=host.docker.internal:host-gateway` to the
`docker run` command.
+
### `.mcp.json` ###
Add to your project root:
@@ -64,7 +66,7 @@ Add to your project root:
}
```
-**Docker (local image):**
+**Docker (local image — build first with `./gradlew jibDockerBuild`):**
```json
{
@@ -86,7 +88,23 @@ Add to your project root:
## HTTP Mode ##
-Start the server first (see [Running the
Server](https://github.com/apache/solr-mcp#running-the-server)), then:
+### Start the Server ###
+
+```bash
+# JAR
+PROFILES=http java -jar build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
+
+# Or Gradle
+PROFILES=http ./gradlew bootRun
+
+# Or Docker (local image — build first with ./gradlew jibDockerBuild)
+docker run -p 8080:8080 --rm \
+ -e PROFILES=http \
+ -e SOLR_URL=http://host.docker.internal:8983/solr/ \
+ solr-mcp:latest
+```
+
+**Linux users** (Docker option): add
`--add-host=host.docker.internal:host-gateway` to the `docker run` command.
### CLI ###
diff --git a/docs/site/content/pages/mcp/clients/claude-desktop.md
b/docs/site/content/pages/mcp/clients/claude-desktop.md
index e849131d..cd8c968f 100644
--- a/docs/site/content/pages/mcp/clients/claude-desktop.md
+++ b/docs/site/content/pages/mcp/clients/claude-desktop.md
@@ -18,9 +18,11 @@ Restart Claude Desktop after any configuration change.
STDIO mode communicates via stdin/stdout. This is the simplest setup for local
use.
-### JAR ###
+### Configuration ###
-Requires Java 25+ and a [built
JAR](https://github.com/apache/solr-mcp#running-the-server) (`./gradlew build`).
+Requires Java 25+ and a [built
JAR](https://github.com/apache/solr-mcp#running-the-server) (`./gradlew build`)
for the JAR option.
+
+**JAR:**
```json
{
@@ -36,9 +38,7 @@ Requires Java 25+ and a [built
JAR](https://github.com/apache/solr-mcp#running-t
}
```
-### Docker (local image) ###
-
-Build the image first: `./gradlew jibDockerBuild`
+**Docker (local image — build first with `./gradlew jibDockerBuild`):**
```json
{
@@ -70,13 +70,15 @@ PROFILES=http java -jar
build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
# Or Gradle
PROFILES=http ./gradlew bootRun
-# Or Docker (local image)
+# Or Docker (local image — build first with ./gradlew jibDockerBuild)
docker run -p 8080:8080 --rm \
-e PROFILES=http \
-e SOLR_URL=http://host.docker.internal:8983/solr/ \
solr-mcp:latest
```
+**Linux users** (Docker option): add
`--add-host=host.docker.internal:host-gateway` to the `docker run` command.
+
### Configure Claude Desktop ###
```json
diff --git a/docs/site/content/pages/mcp/clients/cursor.md
b/docs/site/content/pages/mcp/clients/cursor.md
index 73a420f8..86adef50 100644
--- a/docs/site/content/pages/mcp/clients/cursor.md
+++ b/docs/site/content/pages/mcp/clients/cursor.md
@@ -58,7 +58,25 @@ Create `.cursor/mcp.json` in your project root:
## HTTP Mode ##
-Start the server first (see [Running the
Server](https://github.com/apache/solr-mcp#running-the-server)), then:
+### Start the Server ###
+
+```bash
+# JAR
+PROFILES=http java -jar build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
+
+# Or Gradle
+PROFILES=http ./gradlew bootRun
+
+# Or Docker (local image — build first with ./gradlew jibDockerBuild)
+docker run -p 8080:8080 --rm \
+ -e PROFILES=http \
+ -e SOLR_URL=http://host.docker.internal:8983/solr/ \
+ solr-mcp:latest
+```
+
+**Linux users** (Docker option): add
`--add-host=host.docker.internal:host-gateway` to the `docker run` command.
+
+### Configure Cursor ###
```json
{
@@ -70,6 +88,8 @@ Start the server first (see [Running the
Server](https://github.com/apache/solr-
}
```
+### Secured HTTP (OAuth2) ###
+
The configuration is the same for secured and unsecured HTTP. Cursor handles
the MCP OAuth2 flow automatically.
-See the [Cursor MCP
documentation](https://docs.cursor.com/context/model-context-protocol) for the
latest configuration format.
+See [Security](/mcp/security.html) for server-side OAuth2 setup, and the
[Cursor MCP
documentation](https://docs.cursor.com/context/model-context-protocol) for the
latest configuration format.
diff --git a/docs/site/content/pages/mcp/clients/jetbrains.md
b/docs/site/content/pages/mcp/clients/jetbrains.md
index db42ce8d..a4ca9d9a 100644
--- a/docs/site/content/pages/mcp/clients/jetbrains.md
+++ b/docs/site/content/pages/mcp/clients/jetbrains.md
@@ -59,7 +59,25 @@ Create `.junie/mcp/mcp.json` in your project root:
## HTTP Mode ##
-Start the server first (see [Running the
Server](https://github.com/apache/solr-mcp#running-the-server)), then:
+### Start the Server ###
+
+```bash
+# JAR
+PROFILES=http java -jar build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
+
+# Or Gradle
+PROFILES=http ./gradlew bootRun
+
+# Or Docker (local image — build first with ./gradlew jibDockerBuild)
+docker run -p 8080:8080 --rm \
+ -e PROFILES=http \
+ -e SOLR_URL=http://host.docker.internal:8983/solr/ \
+ solr-mcp:latest
+```
+
+**Linux users** (Docker option): add
`--add-host=host.docker.internal:host-gateway` to the `docker run` command.
+
+### Configure the IDE ###
```json
{
@@ -73,6 +91,8 @@ Start the server first (see [Running the
Server](https://github.com/apache/solr-
Or in IDE Settings, select **SSE** transport and enter
`http://localhost:8080/mcp` as the URL.
+### Secured HTTP (OAuth2) ###
+
The configuration is the same for secured and unsecured HTTP. JetBrains IDEs
handle the MCP OAuth2 flow automatically.
-MCP support requires the AI Assistant plugin. See the [JetBrains MCP
documentation](https://www.jetbrains.com/help/idea/model-context-protocol.html)
for the latest configuration format.
+See [Security](/mcp/security.html) for server-side OAuth2 setup. MCP support
requires the AI Assistant plugin — see the [JetBrains MCP
documentation](https://www.jetbrains.com/help/idea/model-context-protocol.html)
for the latest configuration format.
diff --git a/docs/site/content/pages/mcp/clients/mcp-inspector.md
b/docs/site/content/pages/mcp/clients/mcp-inspector.md
index 5dc72f63..df3a8526 100644
--- a/docs/site/content/pages/mcp/clients/mcp-inspector.md
+++ b/docs/site/content/pages/mcp/clients/mcp-inspector.md
@@ -15,13 +15,24 @@ This starts the Inspector UI at `http://localhost:6274`.
***
-## STDIO Mode ##
+## STDIO Mode (Recommended) ##
+
+**JAR:**
1. In MCP Inspector, select **STDIO** transport
2. **Command**: `java`
3. **Arguments**: `-jar /absolute/path/to/solr-mcp-1.0.0-SNAPSHOT.jar`
4. Click **Connect**
+**Docker (local image — build first with `./gradlew jibDockerBuild`):**
+
+1. In MCP Inspector, select **STDIO** transport
+2. **Command**: `docker`
+3. **Arguments**: `run -i --rm -e
SOLR_URL=http://host.docker.internal:8983/solr/ solr-mcp:latest`
+4. Click **Connect**
+
+**Linux users**: add `--add-host=host.docker.internal:host-gateway` to the
arguments.
+
***
## HTTP Mode ##
diff --git a/docs/site/content/pages/mcp/clients/vs-code.md
b/docs/site/content/pages/mcp/clients/vs-code.md
index 081cff26..7326c035 100644
--- a/docs/site/content/pages/mcp/clients/vs-code.md
+++ b/docs/site/content/pages/mcp/clients/vs-code.md
@@ -44,6 +44,8 @@ Create `.vscode/mcp.json` in your project root:
}
```
+**Linux users**: add `"--add-host=host.docker.internal:host-gateway"` to the
`args` array.
+
### User Settings (`settings.json`) ###
Open VS Code Settings (JSON) and add:
@@ -67,7 +69,25 @@ Open VS Code Settings (JSON) and add:
## HTTP Mode ##
-Start the server first (see [Running the
Server](https://github.com/apache/solr-mcp#running-the-server)), then:
+### Start the Server ###
+
+```bash
+# JAR
+PROFILES=http java -jar build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
+
+# Or Gradle
+PROFILES=http ./gradlew bootRun
+
+# Or Docker (local image — build first with ./gradlew jibDockerBuild)
+docker run -p 8080:8080 --rm \
+ -e PROFILES=http \
+ -e SOLR_URL=http://host.docker.internal:8983/solr/ \
+ solr-mcp:latest
+```
+
+**Linux users** (Docker option): add
`--add-host=host.docker.internal:host-gateway` to the `docker run` command.
+
+### Configure VS Code ###
```json
{
@@ -80,6 +100,8 @@ Start the server first (see [Running the
Server](https://github.com/apache/solr-
}
```
+### Secured HTTP (OAuth2) ###
+
The configuration is the same for secured and unsecured HTTP. VS Code handles
the MCP OAuth2 flow automatically.
-See the [VS Code MCP
documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for
the latest configuration format.
+See [Security](/mcp/security.html) for server-side OAuth2 setup, and the [VS
Code MCP
documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for
the latest configuration format.
