Skip to content

Document how to enable the MCP server - #350

Merged
ravikiranvm merged 1 commit into
ops-4802-mcp-server-docsfrom
ops-4863-enable-mcp-server-docs
Sep 23, 2026
Merged

ravikiranvm merged 1 commit into
ops-4802-mcp-server-docsfrom
ops-4863-enable-mcp-server-docs

Conversation

@ravikiranvm

Copy link
Copy Markdown
Contributor

Stacked on #348. Adds the administrator half that the MCP server page was missing: its prerequisites say "an OpenOps environment with the MCP server enabled" without saying how.

Changes to ai-assistance/mcp-server.mdx

  • New Enabling the MCP server section for the Docker Compose deployment: TLS requirement, the three .env settings (OPS_OAUTH_ENABLED, OPS_OAUTH_RS_CLIENT_SECRET, COMPOSE_PROFILES=mcp), restart, a curl check against the protected-resource metadata, and how to disable.
  • A note for installations created before 0.6.26: updates keep .env, so the MCP block has to be copied from .env.defaults by hand.
  • Prerequisites now link to the new section.

Changes to ai-assistance/overview.mdx

  • Calls the assistant's server the "built-in" MCP server, so readers don't take the external endpoint to be on by default.

Notes

  • Matches Add MCP service to docker compose openops#2521 (compose service, opt-in profile, empty secret by default) and the released openops-mcp 0.2.0.
  • The section states "0.6.26 or later". If the existing 0.6.26 draft in the openops repo is published before #2521 merges, this needs to become 0.6.27.
  • Helm is left out because the docs site has no Helm deployment page.

Part of OPS-4863.

🤖 Generated with Claude Code

The MCP server page told readers they need an environment with the
server enabled but nothing explained how. Add an administrator section
covering TLS, the .env settings, the compose profile, the missing block
on pre-0.6.26 installs, verification and disabling. Link it from the
prerequisites and call the assistant's server "built-in" in the overview
so it is not confused with the opt-in external one.

Part of OPS-4863.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@linear

linear Bot commented Sep 21, 2026

Copy link
Copy Markdown

OPS-4863

@ravikiranvm
ravikiranvm merged commit a33a97d into ops-4802-mcp-server-docs Sep 23, 2026
2 of 3 checks passed
@ravikiranvm
ravikiranvm deleted the ops-4863-enable-mcp-server-docs branch September 23, 2026 12:59
ravikiranvm added a commit that referenced this pull request Sep 25, 2026
* Add MCP server documentation

* Document how to enable the MCP server (#350)

The MCP server page told readers they need an environment with the
server enabled but nothing explained how. Add an administrator section
covering TLS, the .env settings, the compose profile, the missing block
on pre-0.6.26 installs, verification and disabling. Link it from the
prerequisites and call the assistant's server "built-in" in the overview
so it is not confused with the opt-in external one.

Part of OPS-4863.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>

* Remove cursor, modify openops version and add screenshots for claude code authorisation

* Add hyperlinks to v0.7.0

* Improve helm section

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant