Docs #10
Docs #10
Conversation
- Consolidate all reference content into single reference.md page - Move individual reference files from reference/ to references/
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughRestructures MCP Gateway docs and navigation: removes several "Core Concepts" and "Features" pages, adds a consolidated "Reference" section with modular reference pages (CLI, Storage, Authentication, Proxy, REST API, Gateway MCP Server, Web UI), converts Getting Started to MDX, and updates Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🪛 Gitleaks (8.30.0)src/content/docs/mcp-gateway/reference.md[high] 37-37: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource. (curl-auth-header) 🔇 Additional comments (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (2)
src/content/docs/mcp-gateway/references/storage.md (1)
8-13: Add a language identifier to the storage layout code blockMarkdownlint flagged this fenced block for missing a language. Adding one (e.g.
text) will avoid MD040 and help tooling.-``` +```text ~/.mcp-gateway/ ├── mcp.json # Server registry ├── logs.db # SQLite traffic logs └── logs.db-* # SQLite files -``` +```src/content/docs/mcp-gateway/getting-started.mdx (1)
60-63: Add a language to the Claude CLI snippet for consistencyFor the Claude example, adding
bashto the fenced block will match the other command examples and aid syntax highlighting:- ``` + ```bash claude mcp add --transport http "linear-mcp" \ "http://localhost:3333/s/linear-mcp/mcp" ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
src/assets/add-mcp-server-form.pngis excluded by!**/*.pngsrc/assets/adding-mcp-server.pngis excluded by!**/*.pngsrc/assets/mcp-server-logs.pngis excluded by!**/*.pngsrc/assets/terminal-output.pngis excluded by!**/*.png
📒 Files selected for processing (21)
astro.config.ts(1 hunks)src/content/docs/mcp-gateway/core-concepts/activity-logging.md(0 hunks)src/content/docs/mcp-gateway/core-concepts/interfaces.md(0 hunks)src/content/docs/mcp-gateway/core-concepts/server-management.md(0 hunks)src/content/docs/mcp-gateway/features/cli-options.md(0 hunks)src/content/docs/mcp-gateway/features/storage.md(0 hunks)src/content/docs/mcp-gateway/features/terminal-ui.md(0 hunks)src/content/docs/mcp-gateway/features/web-interface.md(0 hunks)src/content/docs/mcp-gateway/getting-started.md(0 hunks)src/content/docs/mcp-gateway/getting-started.mdx(1 hunks)src/content/docs/mcp-gateway/index.md(1 hunks)src/content/docs/mcp-gateway/reference.md(1 hunks)src/content/docs/mcp-gateway/references/authentication.md(1 hunks)src/content/docs/mcp-gateway/references/cli.md(1 hunks)src/content/docs/mcp-gateway/references/gateway-mcp-server.md(1 hunks)src/content/docs/mcp-gateway/references/proxy.md(1 hunks)src/content/docs/mcp-gateway/references/rest-api.md(1 hunks)src/content/docs/mcp-gateway/references/storage.md(1 hunks)src/content/docs/mcp-gateway/references/web-ui.md(1 hunks)src/content/docs/mcp-gateway/troubleshooting.md(0 hunks)src/content/docs/reference/example.md(0 hunks)
💤 Files with no reviewable changes (10)
- src/content/docs/mcp-gateway/features/cli-options.md
- src/content/docs/mcp-gateway/core-concepts/activity-logging.md
- src/content/docs/mcp-gateway/features/terminal-ui.md
- src/content/docs/mcp-gateway/features/web-interface.md
- src/content/docs/mcp-gateway/core-concepts/interfaces.md
- src/content/docs/mcp-gateway/features/storage.md
- src/content/docs/mcp-gateway/troubleshooting.md
- src/content/docs/mcp-gateway/getting-started.md
- src/content/docs/mcp-gateway/core-concepts/server-management.md
- src/content/docs/reference/example.md
🧰 Additional context used
🪛 Gitleaks (8.30.0)
src/content/docs/mcp-gateway/references/authentication.md
[high] 12-12: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
🪛 markdownlint-cli2 (0.18.1)
src/content/docs/mcp-gateway/references/storage.md
8-8: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
src/content/docs/mcp-gateway/references/proxy.md
8-8: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
src/content/docs/mcp-gateway/reference.md
47-47: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
69-69: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
src/content/docs/mcp-gateway/index.md
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (6)
src/content/docs/mcp-gateway/references/web-ui.md (1)
1-15: Clear concise overview of Web UI featuresThe access URL, feature list, and real‑time behavior are described clearly and consistently with the rest of the reference docs. No changes needed.
src/content/docs/mcp-gateway/references/authentication.md (1)
1-16: Authentication model and examples look solidThe separation between authenticated core endpoints and unauthenticated proxy endpoints is clear, and examples use safe placeholders (
YOUR_TOKEN). This page fits cleanly with the rest of the gateway reference.src/content/docs/mcp-gateway/references/cli.md (1)
1-25: CLI flags and environment mapping are well documentedThe options table and examples (including the
MCP_GATEWAY_TOKENusage) are clear and succinct, and the “flags override env vars” note removes ambiguity. No changes needed.src/content/docs/mcp-gateway/references/gateway-mcp-server.md (1)
1-17: Gateway MCP tools table is clear and actionableEndpoint, auth requirement, and the available tools are documented in a compact, easy‑to‑scan way. This should be enough for users to discover gateway‑level automation capabilities.
src/content/docs/mcp-gateway/references/rest-api.md (1)
1-62: REST API endpoints and examples are well coveredEndpoint descriptions, query parameters, and curl/JSON examples are coherent and consistent with the authentication model described elsewhere. Looks good as a primary reference.
astro.config.ts (1)
141-166: Updated MCP Gateway “Reference” sidebar looks consistentThe new “Reference” group with CLI, Storage, Authentication, Proxy, REST API, Gateway MCP Server, and Web UI entries matches the structure of the new reference content and should give users a clear map of the gateway surface.
|
bugbot run! |
|
Skipping Bugbot: Bugbot is disabled for this repository |
|
@codex review |
|
bugbot run! |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - Go to **Manage Servers** in the right sidebar, then click **Add Server**. | ||
|  | ||
|
|
||
| - Fill in the server details | ||
|  |
There was a problem hiding this comment.
The screenshots are referenced with absolute /src/assets/... URLs, but the images were added under src/assets and that directory is not served in the built site (only public/ or processed /assets/ outputs are). As a result, these screenshots will render as 404s (same pattern on lines 51, 54, and 68). Import the assets or move them under public so the images resolve.
Useful? React with 👍 / 👎.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Update docs
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
Note
Reorganizes MCP Gateway docs around a consolidated Reference, adds dedicated reference pages, updates sidebar/nav, replaces Getting Started with interactive MDX, and revises Overview with architecture and endpoints.
astro.config.tssidebar: replace "Core Concepts"/"Features" withReferenceanchors (/mcp-gateway/reference#...).src/content/docs/mcp-gateway/getting-started.mdx: tabbed installers, step-by-step quickstart, images, and next steps.src/content/docs/mcp-gateway/index.md: clarified overview, add architecture diagram, and endpoints table.src/content/docs/mcp-gateway/reference.mdcoveringCLI,Authentication,Proxy,Storage,Web UI,REST API, andGateway MCP server.src/content/docs/mcp-gateway/references/:cli.md,authentication.md,proxy.md,rest-api.md,gateway-mcp-server.md,storage.md,web-ui.md.core-concepts/*andfeatures/*pages (e.g.,server-management.md,activity-logging.md,interfaces.md,terminal-ui.md,web-interface.md,cli-options.md,storage.md) andtroubleshooting.md.Written by Cursor Bugbot for commit a7ce2a6. This will update automatically on new commits. Configure here.