[OPIK-6783] [DOCS] Use OPIK_WORKSPACE (optional) for opik-mcp instead of COMET_WORKSPACE#6960
Merged
Merged
Conversation
…ad of COMET_WORKSPACE Mirrors comet-ml/opik-mcp#141: OPIK_WORKSPACE is now the primary, OPIK_-prefixed env var for the opik-mcp server workspace (matching the Opik SDK). It is optional and defaults to "default"; COMET_WORKSPACE stays as a deprecated backward-compat alias. Updates the description and all host setup snippets (Claude Code, Cursor, VS Code Copilot, MCP Inspector). OPIK-6783 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
Contributor
awkoy
changed the title
andrescrz
approved these changes
Jun 4, 2026
jverre
pushed a commit
that referenced
this pull request
Jun 12, 2026
…ad of COMET_WORKSPACE (#6960) Mirrors comet-ml/opik-mcp#141: OPIK_WORKSPACE is now the primary, OPIK_-prefixed env var for the opik-mcp server workspace (matching the Opik SDK). It is optional and defaults to "default"; COMET_WORKSPACE stays as a deprecated backward-compat alias. Updates the description and all host setup snippets (Claude Code, Cursor, VS Code Copilot, MCP Inspector). OPIK-6783 Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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
2 participants
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.
Details
Docs counterpart to comet-ml/opik-mcp#141 (OPIK-6783). The opik-mcp server now uses
OPIK_WORKSPACEas the primary,OPIK_-prefixed env var for the workspace (matching the Opik SDK and the server's ownOPIK_API_KEY). It is optional and defaults todefault;COMET_WORKSPACEstays as a deprecated backward-compat alias (OPIK_WORKSPACEwins if both are set).prompt_engineering/mcp-server.mdx: "Before you start" description + all host setup snippets (Claude Code, Cursor, VS Code Copilot, MCP Inspector) now useOPIK_WORKSPACE.OPIK_WORKSPACEis optional and can be omitted (the server defaults todefault); set it only for a named cloud workspace.--apiKeyCLI flags).Change checklist
Issues
AI-WATERMARK
AI-WATERMARK: yes
OPIK_WORKSPACEenv-var change in feat(config): OPIK_WORKSPACE env var + optional workspace (default "default") [OPIK-6783] opik-mcp#141 (one.mdxfile).Testing
Docs-only change (single
.mdxfile), so no code/tests in this PR. Verified:grepconfirms every opik-mcp workspace env reference on the page now usesOPIK_WORKSPACE; only the intentional deprecated-alias mention ofCOMET_WORKSPACEremains.default, COMET_WORKSPACE alias) was verified end-to-end against the running opik-mcp server in feat(config): OPIK_WORKSPACE env var + optional workspace (default "default") [OPIK-6783] opik-mcp#141 (initialize handshake + a real tool call; all four env permutations resolved as documented).Documentation
This PR is the documentation update —
apps/opik-documentation/documentation/fern/docs-v2/prompt_engineering/mcp-server.mdx.