You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,3 +7,5 @@
7
7
- add an Alpine-based Docker image build + entrypoint script plus usage docs for container publishing
8
8
- publish the container automatically to GHCR using `.github/workflows/docker.yml`
9
9
- update Docker builder stage to the latest stable Rust toolchain (1.91.1) for smaller, faster binaries
10
+
- add a self-contained pkgx pantry (`pkgx/`) with build/test metadata so `pkgx cratedocs` can install the server via the pkgx runtime, plus README instructions for using and upstreaming it
11
+
- add `just install-pkgx` to verify the pkgx pantry wiring end-to-end (falls back to a helpful message until the package is mirrored onto dist.pkgx.dev)
Copy file name to clipboardExpand all lines: README.md
+62-1Lines changed: 62 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Rust Cargo Docs RAG MCP
2
2
3
-
`rust-cargo-docs-rag-mcp` is an MCP (Model Context Protocol) server that provides Rust crate documentation lookup and search tools intended for LLM assistants and other tooling.
3
+
`rust-cargo-docs-rag-mcp` is an MCP (Model Context Protocol) server that provides tools for Rust crate documentation lookup. It allows LLMs to look up documentation for Rust crates they are unfamiliar with.
4
4
5
5
This README focuses on how to build, version, release, and install the project using two common paths:
6
6
1. pkgx (build/install locally from source)
@@ -10,6 +10,30 @@ This README focuses on how to build, version, release, and install the project u
`pkgx` will download the tagged source tarball, compile `cratedocs` with the required Rust toolchain, and cache the result for subsequent runs. Once you're ready to upstream this package to the central [pkgx pantry](https://github.com/pkgxdev/pantry), copy `pkgx/projects/github.com/promptexecution/rust-cargo-docs-rag-mcp/package.yml` into a new PR there.
35
+
36
+
## Running the Server
13
37
This repository is wired to Cocogitto via `cog.toml`. Typical flow to create a release:
14
38
15
39
1. Install Cocogitto (once)
@@ -66,6 +90,32 @@ Run in stdio mode:
66
90
docker run --rm -e CRATEDOCS_MODE=stdio -i ghcr.io/promptexecution/rust-cargo-docs-rag-mcp:latest
67
91
```
68
92
93
+
### Using Docker
94
+
95
+
You can also build and run the server in an Alpine-based container. Prebuilt images are automatically published to GHCR via [`.github/workflows/docker.yml`](.github/workflows/docker.yml):
docker run --rm -p 8080:8080 promptexecution/rust-cargo-docs-rag-mcp
109
+
```
110
+
111
+
Configuration is controlled through environment variables:
112
+
-`CRATEDOCS_MODE` (default `http`): switch to `stdio` to expose the stdio MCP server
113
+
-`CRATEDOCS_ADDRESS` (default `0.0.0.0:8080`): bind the HTTP server to a specific interface/port
114
+
-`CRATEDOCS_DEBUG` (default `false`): set to `true` to enable verbose logging in HTTP mode
115
+
116
+
All additional arguments appended to `docker run ... -- <args>` are forwarded to the underlying `cratedocs` process.
117
+
118
+
### Directly Testing Documentation Tools
69
119
### Environment Variables
70
120
71
121
-`CRATEDOCS_MODE` (default: `http`) — set to `stdio` to run the stdio MCP server
@@ -397,6 +447,17 @@ Then reference it normally in `mcp_settings.json`:
397
447
398
448
---
399
449
450
+
## Versioning & Releases
451
+
452
+
This repository includes a [`cog.toml`](./cog.toml) profile wired to [`scripts/set-version.sh`](./scripts/set-version.sh) so [Cocogitto](https://github.com/cocogitto/cocogitto) can bump the crate version and regenerate the changelog automatically.
453
+
454
+
Typical release flow:
455
+
1.`cargo install cocogitto` (once)
456
+
2.`cog bump minor` (or `patch`/`major`) – this updates `Cargo.toml`, `Cargo.lock`, and `CHANGELOG.md`
457
+
3. Review the generated changelog, run tests, and push the resulting tag/commit
458
+
459
+
See [`CHANGELOG.md`](./CHANGELOG.md) for the latest published versions.
0 commit comments