Skip to content

docs: add task-based setup and troubleshooting guides - #1736

Merged
Dumbris merged 1 commit into
mainfrom
codex/docs-task-guides
Oct 22, 2026
Merged

Dumbris merged 1 commit into
mainfrom
codex/docs-task-guides

Conversation

@Dumbris

@Dumbris Dumbris commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Problem and change

Readers can find individual feature references but lack a complete path for sharing one MCP setup across clients or diagnosing a tool that an agent cannot use.

Add two task-based guides: Reuse one MCP setup in two AI clients (Claude Code and Codex CLI) and Find out why an agent cannot use a tool. Each includes prerequisites, concrete commands, expected results, recovery steps and a completion check in Activity. Add a small Guides landing page, sidebar navigation, and links from the homepage and Quick Start. Include the new section in the shared HTML/LLM publication list.

The guides distinguish client authentication from upstream authentication, operator visibility from client scope, and scan evidence from an approval decision. Validation stamps explicitly distinguish protocol-session testing from actual AI-client UI runs.

Validation

  • npm --prefix website run build: passed, including postbuild verification of all 132 published LLM links, full export, metadata, sitemap and robots.
  • go test ./cmd/release-gate ./internal/connect -count=1: passed.
  • Released MCPProxy v0.71.1 in isolated scratch storage on port 19876: added Context7 in manual quarantine, fetched/reviewed definitions and scan, explicitly approved selected tools, confirmed preflight ready.
  • Two independent test client credentials and MCP sessions discovered and called the real Context7 resolver. Activity showed distinct client identities, arguments, successful responses and invalid-argument failures.
  • Reproduced tool disable/preflight exit 11, re-enable/ready, unknown tool exit 12, and successful retry. Verified client-view CLI and activity show --include-response against the released binary.
  • Browser inspection confirmed all three pages render and navigation works.
  • Independent fresh-context review: VERDICT: PASS, with no remaining actionable findings after correcting the client-view command and adding --include-response.

No production daemon settings or AI-client configuration files were changed during validation. No end-to-end Claude Code/Codex UI run is claimed.

Deployed preview

Guides preview verified live: all 132 exported documentation routes return successful responses after canonical redirects; all three new routes have descriptions and canonical URLs and appear in the sitemap and LLM exports.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying mcpproxy-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 691a512
Status: ✅  Deploy successful!
Preview URL: https://ba04d0ac.mcpproxy-docs.pages.dev
Branch Preview URL: https://codex-docs-task-guides.mcpproxy-docs.pages.dev

View logs

@github-actions

Copy link
Copy Markdown
Contributor

📦 Build Artifacts

Workflow Run: View Run
Branch: codex/docs-task-guides

Available Artifacts

  • archive-darwin-amd64 (32 MB)
  • archive-darwin-arm64 (29 MB)
  • archive-linux-amd64 (19 MB)
  • archive-linux-arm64 (17 MB)
  • archive-windows-amd64 (32 MB)
  • archive-windows-arm64 (28 MB)
  • frontend-dist-pr (0 MB)
  • installer-dmg-darwin-amd64 (28 MB)
  • installer-dmg-darwin-arm64 (25 MB)
  • smart-mcp-proxymcpproxy-goK015J1.dockerbuild (0 MB)

How to Download

Option 1: GitHub Web UI (easiest)

  1. Go to the workflow run page linked above
  2. Scroll to the bottom "Artifacts" section
  3. Click on the artifact you want to download

Option 2: GitHub CLI

gh run download 39794809384 --repo smart-mcp-proxy/mcpproxy-go

Note: Artifacts expire in 14 days.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Dumbris
Dumbris merged commit 2146860 into main Oct 22, 2026
50 checks passed
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.

2 participants