PDX-0: docs(mcp) — scrub internal ticket refs from customer docs#178
Merged
mrdailey99 merged 1 commit intoMay 15, 2026
Merged
Conversation
RCA: The published customer-facing MCP guides (docs/mcp.md and docs/mcp-pilot-guide.md) leaked internal Jira identifiers — "PDX-464", "PDX-479" — and a corresponding internal-only version reference ("1.5.0 (PDX-479)"). These ticket IDs are only meaningful inside the Provar engineering org and should not appear in docs that ship to pilots and customers.
Fix: Rewrite the three offending passages without losing technical meaning. (1) docs/mcp.md catalog-source note replaces "(dev build or pre-PDX-464 release)" with "(dev build or an older release that predates this metadata)". (2) docs/mcp-pilot-guide.md Scenario 12 Background drops "in 1.5.0 (PDX-479)" and describes the regression as "previously observed". (3) docs/mcp-pilot-guide.md Scenario 12 FAIL action replaces "file against PDX-479 (or its successor)" with "report it to the Provar team". No tool, schema, or behaviour changes — docs only.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Quality Orchestrator🟢 LOW · No test files mapped. ⚡ quality-orchestrator · |
Contributor
There was a problem hiding this comment.
Pull request overview
Doc-only cleanup to remove internal Jira/version references from customer-facing MCP documentation before release.
Changes:
- Reworded catalog-source metadata guidance to avoid an internal ticket reference.
- Reworded Scenario 12 background and failure reporting instructions to remove PDX ticket/version references.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/mcp.md |
Updates catalog-source metadata wording for older builds without internal ticket references. |
docs/mcp-pilot-guide.md |
Removes internal regression ticket/version references from Scenario 12 guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Doc-only cleanup. Removes internal Jira ticket references (PDX-XXX) and an internal-only version label from the customer-facing MCP guides on
developso the next release → main doesn't leak them.Found via grep of
PDX-\d+againstdocs/*.mdafter the PR #172 release-prep audit.Changes
docs/mcp.md(catalog-source resource note, ~L2105) — replace"(dev build or pre-PDX-464 release)"with"(dev build or an older release that predates this metadata)".docs/mcp-pilot-guide.md(Scenario 12 Background, ~L446) — drop"in 1.5.0 (PDX-479)"; describe the regression as"previously observed"without citing ticket or version.docs/mcp-pilot-guide.md(Scenario 12 FAIL action, ~L472) — replace"file against PDX-479 (or its successor)"with"report it to the Provar team".No tool, schema, smoke, or behaviour changes.
Verification
Test plan
rg "PDX-\d+" docs/*.mdreturns no hits on this branchdocs/mcp.mdcatalog-source description still accurately explains whencommitSha/fetchedAt/schemasUpdatedarenullOut of scope
docs/provar-mcp-public-docs.mdanddocs/university-of-provar-mcp-course.mdare maintained separately by the Provar team (per CLAUDE.md) — flagging here for manual review but not modified by this PR.🤖 Generated with Claude Code