MCP Server Release Docs - #1943
Merged
Merged
Conversation
… configuration reference - index.md: lead with a concrete scenario and a direct two-point "why use it" instead of jargon-forward prose; demote the tools/resources/prompts primitive breakdown to a closing aside. - Split the old monolithic installation.md (Docker + every npx client) into installation.md (Docker + Claude Code, the fastest path) and other-setups.md (every other client, plus npx). - Add best-practices.md: dedicated-token, ACL-scoping, non-prod-first checklist for pointing this at a real instance. - Add configuration.md: every environment variable the server reads, in one place, grouped by concern. installation.md and other-setups.md now point here instead of each carrying a partial, duplicate table. - Fix the minimum-Rundeck-version claim: it was "6.0", but the default RUNDECK_API_VERSION (59) was introduced in 6.1.0, not 6.0.0/6.0.1 - confirmed via git history on rundeck-api.yml (the version bump commit is titled "6.1.0 Release Prep") and the 5.20.0/6.1.0 changelogs. - faq.md: add the Docker-image OpenAPI-validation gap (spec file excluded from the sparse checkout, so api_call never rejects bad params there). - tools.md: document the api_call fallback that job_create/job_validate/ runner_create/acl_manage guidance mode points to. - Update the sidebar to match the new page set and order.
…bilities page Replace tools.md, resources.md, and prompts.md with capabilities.md, rewritten as prose rather than exhaustive parameter/argument tables. Those tables duplicated what the tool Zod schemas and each MCP client's own prompt picker already surface authoritatively - same staleness risk resources.md already had by its own admission. What's kept is the part that isn't duplicated anywhere: when each tool is (and isn't) the right choice, and the scope/ACL trust caveats (job_create not enforcing org conventions, Runner-level ACL behavior) that best-practices.md and faq.md actually link to. Update every cross-reference (index.md, installation.md, best-practices.md, faq.md, sidebar) accordingly, and re-verify all internal links/anchors across the whole docs/mcp/ set.
…I validation fix Documents the elicitation-based confirmation gate for api_call DELETE/ credential-regen and acl_manage update/delete, plus the SKIP_ELICITATION operator escape hatch (rundeck/mcp#82). Also corrects the FAQ, config reference, and other-setups comparison table, which claimed Docker's sparse docs checkout excludes the OpenAPI spec file — that's since been fixed upstream, so api_call validation is active on Docker too. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new documentation section for the Rundeck / Runbook Automation MCP Server and wires it into the VuePress navigation, including a site-wide announcement pointing readers to the new docs.
Changes:
- Introduces a new
/mcp/documentation section covering overview, installation, configuration, capabilities, best practices, FAQ, and multi-instance setup. - Adds MCP Server to the site navbar and sidebar configuration so the section is discoverable.
- Updates the global layout announcement banner to promote the MCP Server docs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/mcp/index.md | New MCP Server landing/overview page with quick start and section index. |
| docs/mcp/installation.md | Docker + Claude Code “fastest path” installation walkthrough and required env vars. |
| docs/mcp/other-setups.md | Alternative client configurations (Claude Desktop/Cursor/VS Code) and npx-based setup guidance. |
| docs/mcp/best-practices.md | Operational/security checklist for running against real instances. |
| docs/mcp/configuration.md | Single reference table for all supported environment variables. |
| docs/mcp/capabilities.md | Technical explanation of tools/resources/prompts and safety behaviors. |
| docs/mcp/multiple-instances.md | RUNDECK_INSTANCES registry format and rundeck_connect usage. |
| docs/mcp/faq.md | Troubleshooting guidance for common setup and behavior questions. |
| docs/.vuepress/sidebar-menus/mcp.ts | Adds MCP Server section to the VuePress sidebar. |
| docs/.vuepress/config.ts | Registers the /mcp/ sidebar mapping. |
| docs/.vuepress/navbar-menus/development.js | Adds MCP Server link to the development navbar menu. |
| docs/.vuepress/layouts/Layout.vue | Updates homepage + sidebar announcement content to promote MCP Server docs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
ltamaster
approved these changes
Aug 26, 2026
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
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.
Adds a new documentation section for the Rundeck / Runbook Automation MCP Server and wires it into the VuePress navigation, including a site-wide announcement pointing readers to the new docs.
Changes:
Introduces a new /mcp/ documentation section covering overview, installation, configuration, capabilities, best practices, FAQ, and multi-instance setup.
Adds MCP Server to the site navbar and sidebar configuration so the section is discoverable.
Updates the global layout announcement banner to promote the MCP Server docs.