adityamparikh opened a new pull request, #151:
URL: https://github.com/apache/solr-mcp/pull/151
Builds on **#147** (@epugh's 1.0.0 docs polish — its commits are included
here) and finishes the job from the review of that PR. Refocuses the README on
end-user *"how to use"* content, moves developer/operational detail into the
docs that own it, ports the unique end-user content from **#95**, and fixes the
factual errors found in #147 — which also exist in the website source pages, so
they flow into **#143** too (separately).
### README.md — now a lean "how to use" guide
- Value prop → **Quick start** (start Solr, build, connect a client, try it)
→ **Example prompts** → tools/resources/prompts tables → essential config →
documentation hub → community.
- Ports from #95: the sample-data blurb (films 1,100+/books) and the
categorized **Example prompts**.
- Defers the full per-client matrix to the in-repo site pages
(`docs/site/content/pages/mcp/`, from #143), security to `docs/security/`,
observability to the site page, and build/Docker/native/SBOM to `dev-docs/`.
- `README.md`: **−537 / +~50** lines.
### Fixes the factual errors from the #147 review
- **`SECURITY_ENABLED` → `HTTP_SECURITY_ENABLED`** (the real toggle is
`http.security.enabled=${HTTP_SECURITY_ENABLED:true}`,
`@ConditionalOnProperty(... matchIfMissing=true)` — **secured by default**, not
`false`).
- Removed the broken `solr-mcp:latest-native` reference (no such tag) — the
canonical native run/config now lives in DEPLOYMENT.md with
`:latest-native-stdio`.
- The "published images not yet on a public registry" note is **correct**
(verified: `ghcr.io/apache/solr-mcp` is 404/403).
### CONTRIBUTING.md
- Bare-path references → markdown links; de-duplicated "Publishing to Maven
Local" → links the dev-docs section (per CONTRIBUTING's own "no duplication"
principle).
### dev-docs/
- `DEPLOYMENT.md`: new **"Image variants — why three images"** section (the
matrix, run commands, why Jib builds the JVM image and Paketo the native
variants and why Paketo's JVM image breaks STDIO, native Claude Desktop config)
— relocated out of the README.
- `DEVELOPMENT.md`: the consumer-facing SBOM content (where it ships, fetch
via the actuator endpoint, scan with Trivy/Grype) now lives next to "Generating
the SBOM locally".
### Companion change in #143
The same fixes apply to the website source pages and are pushed to #143:
`clients/jetbrains.md` (`.junie/mcp/mcp.json`), `clients/vs-code.md` (`type:
http`), `security.md` (`HTTP_SECURITY_ENABLED`, secured by default).
### ⚠️ Sequencing
The README's `docs/site/content/pages/mcp/*` links resolve on `main` only
**after #143 lands** (those pages live there). Recommended merge order: **#143
→ this PR**. #143's own description also asks to land first.
### Relationship to #147 / #95
- Supersedes **#147** (its commits are bundled here) — or merge #147 first
and I'll rebase this to delta-only.
- Supersedes **#95** (CONFLICTING; its unique content is ported here) — to
be closed.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
