Open
Conversation
Adds a dev-focused Docker Compose setup with: - mcp service: builds from local Dockerfile, mounts source for editable install so code changes take effect on container restart without rebuild - redis service: Redis 7 alpine for OAuth token storage - .env.docker template with all required environment variables - .env.docker.local added to .gitignore for local secret overrides Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- deploy/docker-compose.yaml: production setup using published image (no build), with Redis volume for persistent token storage - deploy/variables.env: production env template with all required variables - README: add Self-Hosting and Local Development sections covering Docker Compose, standalone uv setup, tests, and linting - .gitignore: ignore deploy/variables.env.local for local secret overrides Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Switch to valkey/valkey:8-alpine in dev and prod compose files - Remove exposed port for Valkey in both (internal only) - Update README troubleshooting and services table accordingly Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
COPY --from=ghcr.io/astral-sh/uv:latest fails when GHCR is inaccessible. Switch to pip install uv which works without registry auth. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
If PLANE_OAUTH_PROVIDER_CLIENT_ID / CLIENT_SECRET are not set, the server now starts successfully with only the header API-key endpoint available. OAuth and SSE routes are skipped with a warning log instead of crashing. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This reverts commit 7e3035f.
command appends to the Dockerfile ENTRYPOINT, causing python -m plane_mcp to receive 'sh' as the server mode argument. Use entrypoint override instead. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
OAuth credentials are required by the app to start. For local dev without a real OAuth app, dummy values allow the server to start with the header API-key endpoint functional. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Documents install/upgrade/uninstall via helm.plane.so, minimal values.yaml example, and full key values reference based on the plane-mcp-server chart. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds Docker-based production and local development deployment artifacts, a Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
deployments/README.md (1)
163-166: Minor: comment mentions "Redis" but the service is Valkey.For consistency with the rest of the documentation, consider updating the comment.
📝 Suggested fix
**Reset and start fresh:** ```bash -docker compose down -v # removes Redis volume too +docker compose down -v # removes Valkey volume too docker compose up -d</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@deployments/README.mdaround lines 163 - 166, Update the explanatory inline
comment next to the command "docker compose down -v" in the README so it refers
to Valkey instead of Redis (e.g., change the comment "removes Redis volume too"
to "removes Valkey volume too") to keep service names consistent with the rest
of the documentation.</details> </blockquote></details> <details> <summary>docker-compose.yml (1)</summary><blockquote> `19-21`: **Entrypoint reinstalls dependencies on every container start.** The current entrypoint runs `uv pip install --system -e '.[dev]'` each time the container starts, adding ~5-10s startup delay. This ensures dependencies stay synced with `pyproject.toml` changes but may be slower than desired for frequent restarts. If faster restarts are preferred, you could add a conditional check or use a separate initialization script. However, for a dev workflow, the current approach is pragmatic and ensures consistency. <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docker-compose.ymlaround lines 19 - 21, The entrypoint is reinstalling deps
on every container start via the entrypoint array that runs "uv pip install
--system -e '.[dev]'" before "python -m plane_mcp http", causing slow restarts;
change this to either move the install step into a one-time init script (run at
image build or via a separate startup-only script) or add a conditional check in
the entrypoint that skips "uv pip install --system -e '.[dev]'" when
dependencies are already up-to-date (e.g., check for a marker file or compare
timestamps), then run "python -m plane_mcp http" as usual.</details> </blockquote></details> <details> <summary>deployments/variables.env (1)</summary><blockquote> `21-24`: **Consider using a placeholder instead of `localhost` for production template.** `PLANE_OAUTH_PROVIDER_BASE_URL=http://localhost:8211` may be overlooked in production deployments, causing OAuth callbacks to fail. A placeholder makes it clearer this must be changed. <details> <summary>📝 Suggested fix</summary> ```diff # Public URL your MCP clients reach the server on -PLANE_OAUTH_PROVIDER_BASE_URL=http://localhost:8211 +PLANE_OAUTH_PROVIDER_BASE_URL=https://mcp.yourdomain.com🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@deployments/variables.env` around lines 21 - 24, The PLANE_OAUTH_PROVIDER_BASE_URL environment variable currently defaults to "http://localhost:8211" which can be missed in production; update the template to use a clear placeholder (e.g., "https://YOUR_DOMAIN[:PORT]" or "https://mcp.example.com") so operators must replace it before deploy and include the protocol and port if applicable; change the PLANE_OAUTH_PROVIDER_BASE_URL entry to that placeholder and add a short comment indicating it must be set to the public OAuth callback URL.Dockerfile (1)
8-8: Consider pinning theuvversion for reproducible builds.The switch from GHCR copy to pip install avoids auth issues, but an unpinned
uvmay cause inconsistent builds. The latest version is 0.11.0.♻️ Suggested fix
-RUN pip install --no-cache-dir uv +RUN pip install --no-cache-dir uv==0.11.0🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@Dockerfile` at line 8, Pin the uv package to a specific version in the Dockerfile to ensure reproducible builds: replace the current RUN pip install --no-cache-dir uv invocation with a versioned install (e.g., uv==0.11.0) so the RUN pip install command explicitly installs uv==0.11.0 rather than the unpinned package.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@deployments/docker-compose.yaml`:
- Around line 3-5: Update the setup comment in docker-compose.yaml to reference
the correct template filename: change the instruction that says "cp
variables.env.example variables.env" to use the actual template name present in
the repo (e.g., "cp variables.env variables.env.example" or simply "cp
variables.env variables.env" depending on intended flow), and adjust the
subsequent note to say "edit variables.env" so the comment matches the real
template filename used by the project.
In `@README.md`:
- Around line 243-246: The fenced code block showing APP_RELEASE_VERSION lacks a
language specifier; update the README's snippet containing the line
"APP_RELEASE_VERSION=v0.2.8" to use an env language tag (e.g., start the block
with ```env) so syntax highlighting and accessibility are improved for that code
block.
---
Nitpick comments:
In `@deployments/README.md`:
- Around line 163-166: Update the explanatory inline comment next to the command
"docker compose down -v" in the README so it refers to Valkey instead of Redis
(e.g., change the comment "removes Redis volume too" to "removes Valkey volume
too") to keep service names consistent with the rest of the documentation.
In `@deployments/variables.env`:
- Around line 21-24: The PLANE_OAUTH_PROVIDER_BASE_URL environment variable
currently defaults to "http://localhost:8211" which can be missed in production;
update the template to use a clear placeholder (e.g.,
"https://YOUR_DOMAIN[:PORT]" or "https://mcp.example.com") so operators must
replace it before deploy and include the protocol and port if applicable; change
the PLANE_OAUTH_PROVIDER_BASE_URL entry to that placeholder and add a short
comment indicating it must be set to the public OAuth callback URL.
In `@docker-compose.yml`:
- Around line 19-21: The entrypoint is reinstalling deps on every container
start via the entrypoint array that runs "uv pip install --system -e '.[dev]'"
before "python -m plane_mcp http", causing slow restarts; change this to either
move the install step into a one-time init script (run at image build or via a
separate startup-only script) or add a conditional check in the entrypoint that
skips "uv pip install --system -e '.[dev]'" when dependencies are already
up-to-date (e.g., check for a marker file or compare timestamps), then run
"python -m plane_mcp http" as usual.
In `@Dockerfile`:
- Line 8: Pin the uv package to a specific version in the Dockerfile to ensure
reproducible builds: replace the current RUN pip install --no-cache-dir uv
invocation with a versioned install (e.g., uv==0.11.0) so the RUN pip install
command explicitly installs uv==0.11.0 rather than the unpinned package.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8de76d01-3af1-4706-b102-779148e2cc4b
📒 Files selected for processing (8)
.env.docker.gitignoreDockerfileREADME.mddeployments/README.mddeployments/docker-compose.yamldeployments/variables.envdocker-compose.yml
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
300-300: Use safer.envloading for test command.On Line 300,
export $(cat .env.test.local | xargs)breaks on spaces/special chars. Prefer shell-native sourcing.Suggested doc fix
-export $(cat .env.test.local | xargs) && pytest tests/ -v +set -a +source .env.test.local +set +a +pytest tests/ -v🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 300, Replace the fragile export pipeline on Line 300 that uses "export $(cat .env.test.local | xargs) && pytest tests/ -v" with a shell-native sourcing approach: use "set -a; . .env.test.local; set +a; pytest tests/ -v" (or "set -a; source .env.test.local; set +a; pytest tests/ -v") so environment variables from .env.test.local are safely exported even with spaces/special characters.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 239-241: The README's OAuth server URL is incorrect; update the
documented OAuth endpoint from "/mcp" to "/http/mcp" to match the actual mount
used in plane_mcp.__main__ (Mount "/http") so the OAuth transport path aligns
with the app's mounting; change the line listing `http://localhost:8211/mcp` to
`http://localhost:8211/http/mcp`.
---
Nitpick comments:
In `@README.md`:
- Line 300: Replace the fragile export pipeline on Line 300 that uses "export
$(cat .env.test.local | xargs) && pytest tests/ -v" with a shell-native sourcing
approach: use "set -a; . .env.test.local; set +a; pytest tests/ -v" (or "set -a;
source .env.test.local; set +a; pytest tests/ -v") so environment variables from
.env.test.local are safely exported even with spaces/special characters.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fa6ebe08-1beb-496a-aa8d-b278a683f9b9
📒 Files selected for processing (2)
README.mddeployments/docker-compose.yaml
✅ Files skipped from review due to trivial changes (1)
- deployments/docker-compose.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docker-compose.yml(root): dev setup — builds from source, mountsplane_mcp/for live code changes, Valkey for token storage (no exposed port)deployments/docker-compose.yaml: production setup using published image, Valkey with persistent volumedeployments/variables.env: production env templatedeployments/README.md: full deployment docs covering Docker Compose and Helm chart (viahelm.plane.so)README.md: added Self-Hosting and Local Development sectionsDockerfile: fixeduvinstall — replacedCOPY --from=ghcr.io/astral-sh/uvwithpip install uvto avoid GHCR auth failuresTest plan
cp .env.docker .env→docker compose up --buildstarts cleanlyhttp://localhost:8211/http/api-key/mcpplane_mcp/picked up afterdocker compose restart mcpcd deployments && docker compose up -dworks with a validvariables.envplane-helm-chartsCo-authored with Plane-Ai noreply@plane.so
Summary by CodeRabbit
New Features
Documentation
Chores