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 ba020ed docs: add Claude Code onboarding instructions (#49)
ba020ed is described below
commit ba020edd211e20e801fb7e4b386c8386b3f0f8cf
Author: Aditya Parikh <[email protected]>
AuthorDate: Thu Feb 26 11:07:02 2026 +0000
docs: add Claude Code onboarding instructions (#49)
* docs: add Claude Code onboarding instructions for MCP server setup
Add a Claude Code section to the README covering all transport modes:
- STDIO with Docker (CLI and .mcp.json)
- STDIO with JAR (CLI and .mcp.json)
- HTTP mode (CLI and .mcp.json)
Signed-off-by: Aditya Parikh <[email protected]>
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Signed-off-by: adityamparikh <[email protected]>
* fix(docs): use -e short flag for claude mcp add env vars
The --env long form with variadic args greedily consumes the next
positional argument (the server name), causing a parse error. Use the
-e short form which works correctly.
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Signed-off-by: adityamparikh <[email protected]>
---------
Signed-off-by: adityamparikh <[email protected]>
Co-authored-by: Claude Opus 4.6 <[email protected]>
---
README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 81 insertions(+)
diff --git a/README.md b/README.md
index 7cc8694..9dfc30c 100644
--- a/README.md
+++ b/README.md
@@ -178,6 +178,87 @@ Then add to your `claude_desktop_config.json`:
More configuration options: docs/DEPLOYMENT.md#docker-images-with-jib
+### Claude Code
+
+Add Solr MCP to [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
using the CLI or by adding a `.mcp.json` file to your project root.
+
+**STDIO mode (default)**
+
+Using Docker (CLI):
+```bash
+claude mcp add --transport stdio solr-mcp -- docker run -i --rm
ghcr.io/apache/solr-mcp:latest
+```
+
+Using JAR (CLI):
+```bash
+claude mcp add --transport stdio -e SOLR_URL=http://localhost:8983/solr/
solr-mcp -- java -jar /absolute/path/to/solr-mcp-1.0.0-SNAPSHOT.jar
+```
+
+Or add to your project's `.mcp.json`:
+
+Using Docker:
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "type": "stdio",
+ "command": "docker",
+ "args": ["run", "-i", "--rm", "ghcr.io/apache/solr-mcp:latest"],
+ "env": {
+ "SOLR_URL": "http://localhost:8983/solr/";
+ }
+ }
+ }
+}
+```
+
+Using JAR:
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "type": "stdio",
+ "command": "java",
+ "args": ["-jar", "/absolute/path/to/solr-mcp-1.0.0-SNAPSHOT.jar"],
+ "env": {
+ "SOLR_URL": "http://localhost:8983/solr/";
+ }
+ }
+ }
+}
+```
+
+**HTTP mode**
+
+Start the server first (pick one):
+```bash
+# Gradle
+PROFILES=http ./gradlew bootRun
+
+# JAR
+PROFILES=http java -jar build/libs/solr-mcp-1.0.0-SNAPSHOT.jar
+
+# Docker
+docker run -p 8080:8080 --rm -e PROFILES=http ghcr.io/apache/solr-mcp:latest
+```
+
+Then add to Claude Code:
+```bash
+claude mcp add --transport http solr-mcp http://localhost:8080/mcp
+```
+
+Or add to `.mcp.json`:
+```json
+{
+ "mcpServers": {
+ "solr-mcp": {
+ "type": "http",
+ "url": "http://localhost:8080/mcp";
+ }
+ }
+}
+```
+
## Security (OAuth2)
The Solr MCP server supports OAuth2 authentication when running in HTTP mode,
providing secure access control for your
