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 69a23a9 docs: add tester quick-start smoke test guide (#158)
69a23a9 is described below
commit 69a23a9d50f53b17e6727ca539641e289d78c63b
Author: Aditya Parikh <[email protected]>
AuthorDate: Tue Aug 18 17:07:54 2026 -0400
docs: add tester quick-start smoke test guide (#158)
* docs: add tester quick-start smoke test guide
A fast end-to-end smoke test for verifying a solr-mcp release JAR across
Claude Code, Claude Desktop, and MCP Inspector. Covers client registration
for all three transports, a list-collections sanity check, and a full
build-and-query walkthrough against a self-contained 61-document demo
collection with expected-output checkpoints and sample queries.
Lives in dev-docs/ alongside the other contributor/release-verification
guides.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Signed-off-by: adityamparikh <[email protected]>
* docs: note shared-instance caveat for create-collection in smoke test
The demo URL is a shared public Solr, so the 'shows' collection may already
exist from a prior tester's run. create-collection is not idempotent and
errors on an existing name. Add guidance to use a unique collection name
(keeping the doc-count checkpoints valid) with a reuse/delete fallback.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Signed-off-by: adityamparikh <[email protected]>
* Simplify down to the essence needed
---------
Signed-off-by: adityamparikh <[email protected]>
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
Co-authored-by: Eric Pugh <[email protected]>
---
dev-docs/SMOKE_TEST.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 49 insertions(+)
diff --git a/dev-docs/SMOKE_TEST.md b/dev-docs/SMOKE_TEST.md
new file mode 100644
index 0000000..266a646
--- /dev/null
+++ b/dev-docs/SMOKE_TEST.md
@@ -0,0 +1,49 @@
+# solr-mcp — Quick Test (Claude Code · Claude Desktop · MCP Inspector)
+
+A fast end-to-end smoke test for verifying a `solr-mcp` JAR works across the
+three common MCP clients. Use it when validating a release candidate or a
fresh build.
+
+Every client needs the same three things: `command: java`, `args: -jar
/path/to/solr-mcp-X.Y.Z.jar`, `env: SOLR_URL`.
+
+## Step 1 — Start Solr with the techproducts example
+
+```bash
+bin/solr start -e techproducts
+```
+
+You can start any modern version of Solr, but if it's before Solr 10 make sure
you start in Cloud mode.
+
+## Step 2 — Register the server (pick your client)
+
+**Claude Code**
+```bash
+claude mcp add solr-mcp --transport stdio \
+ --env SOLR_URL=http://localhost:8983/solr \
+ -- java -jar /path/to/solr-mcp-X.Y.Z.jar
+claude mcp list # confirm it connects (/mcp inside a session)
+```
+
+**Claude Desktop** — add to `claude_desktop_config.json`, then restart:
+```json
+{ "mcpServers": { "solr-mcp": {
+ "command": "java",
+ "args": ["-jar", "/path/to/solr-mcp-X.Y.Z.jar"],
+ "env": { "SOLR_URL": "http://localhost:8983/solr"; }
+} } }
+```
+
+**MCP Inspector**
+```bash
+SOLR_URL=http://localhost:8983/solr \
+ npx @modelcontextprotocol/inspector java -jar /path/to/solr-mcp-X.Y.Z.jar
+```
+
+## Step 3 — Smoke test
+
+Just ask in plain English.
+
+```text
+"what collections are available?" → techproducts
+"how many documents are in techproducts?" → numDocs: 31
+"show me all the electronics, priciest first" → 12 hits
+```
