docs: add MCP server documentation#268
Conversation
Mirror the absmartly/mcp README into Product Documentation: - Overview, setup (per-client tabs), authentication, tools reference, usage examples - Screenshots copied from the source repo
chris-absmartly
requested review from
bmsilva,
calthejuggler,
marcio-absmartly and
mario-silva
as code owners
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
More reviews will be available in 13 minutes and 26 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (12)
WalkthroughThis PR introduces a complete documentation suite for the ABsmartly MCP server across six new documentation files. A category configuration organises the new section at position 9. The overview page explains the server's core functionality and offers quick install guidance. A dedicated authentication page covers API key, OAuth, and local CLI credential methods alongside security model details. An extensive setup guide provides client-specific configuration instructions for nine platforms including Claude Desktop, Cursor, VS Code, and Gemini, with exported install URL constants for streamlined setup links. A tools reference documents the four exposed tools (discover_commands, get_command_docs, execute_command, and get_auth_status), available MCP resources, built-in prompts, and command group catalogue. Finally, a usage examples page demonstrates practical prompt patterns for common workflows and provides behavioural guidance for destructive operations and confirmation flows. Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 4
🧹 Nitpick comments (1)
docs/web-console-docs/mcp-server/authentication.mdx (1)
85-86: 💤 Low valueConsider adding a comma before "so" for clarity.
When "so" connects two independent clauses, British English style typically includes a comma for improved readability.
✨ Proposed refinement
-- **API error surfacing** — validation errors from the API are returned with - full detail so the assistant can correct them. +- **API error surfacing** — validation errors from the API are returned with + full detail, so the assistant can correct them.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/web-console-docs/mcp-server/authentication.mdx` around lines 85 - 86, The sentence under the "API error surfacing" bullet is missing a comma before "so"; update the text "- **API error surfacing** — validation errors from the API are returned with full detail so the assistant can correct them." to insert a comma before "so" so it reads "...with full detail, so the assistant can correct them." to improve clarity and conform to British English punctuation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/web-console-docs/mcp-server/overview.mdx`:
- Line 67: Change the noun "license" to British English "licence" in the
sentence that currently reads "The MCP server is open source under the MIT
license: see" so it becomes "The MCP server is open source under the MIT
licence: see"; update the same phrase wherever it appears in the document (look
for the exact string "MIT license" or "open source under the MIT license") to
maintain en-GB spelling consistency.
- Around line 16-17: The download link text "Download the DXT extension" points
to the URL https://mcp.absmartly.com/absmartly-mcp.dxt which currently returns
200, but we should validate it serves the expected installable file; update the
content or CI to perform an HTTP HEAD/GET check against that URL and assert
response headers like Content-Type (expected e.g. application/octet-stream or
the DXT-specific MIME) and Content-Disposition (attachment;
filename="absmartly-mcp.dxt") are present and correct, and then edit the
documentation line to mention that the link has been verified or fix the URL if
headers don’t match.
In `@docs/web-console-docs/mcp-server/setup.mdx`:
- Line 42: Multiple Tabs components use different groupId values so auth
selection doesn't persist across clients; unify their groupId to the same
identifier (e.g., replace differing groupId values with "claude-desktop-auth"
for all auth Tabs instances). Locate the Tabs elements (the Tabs component with
groupId attributes around the OAuth/auth selection blocks) and set the same
string for each groupId across the occurrences noted (lines referenced: Tabs
groupId="claude-desktop-auth" and the other auth tab groups) so tab state is
shared across clients.
In `@docs/web-console-docs/mcp-server/usage-examples.mdx`:
- Line 8: Replace the awkward phrase "connected in your AI assistant" with the
idiomatic "connected to your AI assistant" in the sentence that currently reads
"Once the MCP server is connected in your AI assistant (see [Setup](./setup)),",
updating that exact text in the docs file so it reads "Once the MCP server is
connected to your AI assistant (see [Setup](./setup))".
---
Nitpick comments:
In `@docs/web-console-docs/mcp-server/authentication.mdx`:
- Around line 85-86: The sentence under the "API error surfacing" bullet is
missing a comma before "so"; update the text "- **API error surfacing** —
validation errors from the API are returned with full detail so the assistant
can correct them." to insert a comma before "so" so it reads "...with full
detail, so the assistant can correct them." to improve clarity and conform to
British English punctuation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fe624b1c-353e-43e4-9640-afb55566095b
⛔ Files ignored due to path filters (3)
docs/web-console-docs/mcp-server/images/claude-desktop-add-custom-connector.pngis excluded by!**/*.pngdocs/web-console-docs/mcp-server/images/claude-desktop-connectors.pngis excluded by!**/*.pngdocs/web-console-docs/mcp-server/images/oauth-endpoint-prompt.pngis excluded by!**/*.png
📒 Files selected for processing (6)
docs/web-console-docs/mcp-server/_category_.jsondocs/web-console-docs/mcp-server/authentication.mdxdocs/web-console-docs/mcp-server/overview.mdxdocs/web-console-docs/mcp-server/setup.mdxdocs/web-console-docs/mcp-server/tools-reference.mdxdocs/web-console-docs/mcp-server/usage-examples.mdx
|
|
||
| ## Claude Desktop | ||
|
|
||
| <Tabs groupId="claude-desktop-auth"> |
There was a problem hiding this comment.
Use a shared groupId for auth tabs to enable cross-client sync.
These tabs currently use different groupId values, so selecting (for example) “OAuth” in one client section will not persist to others. If the intended behaviour is synced auth selection across sections, set the same groupId for all auth tab groups.
Also applies to: 129-129, 216-216, 296-296, 373-373, 474-474
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/web-console-docs/mcp-server/setup.mdx` at line 42, Multiple Tabs
components use different groupId values so auth selection doesn't persist across
clients; unify their groupId to the same identifier (e.g., replace differing
groupId values with "claude-desktop-auth" for all auth Tabs instances). Locate
the Tabs elements (the Tabs component with groupId attributes around the
OAuth/auth selection blocks) and set the same string for each groupId across the
occurrences noted (lines referenced: Tabs groupId="claude-desktop-auth" and the
other auth tab groups) so tab state is shared across clients.
|
|
||
| # Usage Examples | ||
|
|
||
| Once the MCP server is connected in your AI assistant (see [Setup](./setup)), |
There was a problem hiding this comment.
Use idiomatic wording for connection state.
Line 8 reads awkwardly: “connected in your AI assistant”. “connected to your AI assistant” is clearer for end users.
Suggested edit
-Once the MCP server is connected in your AI assistant (see [Setup](./setup)),
+Once the MCP server is connected to your AI assistant (see [Setup](./setup)),📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Once the MCP server is connected in your AI assistant (see [Setup](./setup)), | |
| Once the MCP server is connected to your AI assistant (see [Setup](./setup)), |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: The preposition ‘to’ seems more likely in this position.
Context: ...mples Once the MCP server is connected in your AI assistant (see Setup...
(AI_HYDRA_LEO_REPLACE_IN_TO)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/web-console-docs/mcp-server/usage-examples.mdx` at line 8, Replace the
awkward phrase "connected in your AI assistant" with the idiomatic "connected to
your AI assistant" in the sentence that currently reads "Once the MCP server is
connected in your AI assistant (see [Setup](./setup)),", updating that exact
text in the docs file so it reads "Once the MCP server is connected to your AI
assistant (see [Setup](./setup))".
- Quick Start: zero-to-running in 5 min via Claude Desktop + OAuth - Troubleshooting: auth, connection, commands, performance - Overview: add why-use-it section, positioning vs SDK/Web Console API - Reorder sidebar: Overview, Quick Start, Setup, Auth, Usage Examples, Troubleshooting, Tools Reference
MDX v1 wrapped <BrowserOnly>{() => ...}</BrowserOnly> children as an
object, not a function, triggering Docusaurus's render-function guard.
Extract the deeplinks into component exports so the render function
is preserved.
- Rename sidebar label "APIs & SDKs" -> "Developer Tools" - Move docs/web-console-docs/mcp-server/ -> docs/APIs-and-SDKs/MCP-Server/ - Slot MCP Server at position 4 in the section (after Platform API) - Refresh Developer Tools overview to mention MCP URL changes from /docs/web-console-docs/mcp-server/* to /docs/APIs-and-SDKs/MCP-Server/*. Safe to do now: the MCP section is not yet in master, so no external links point at the old paths.
Rewrite the section overview to actually describe what's inside: - 4 subsections (SDK Guide, SDK API, Platform API, MCP Server) with what each contains and direct links to the most useful entry points - "Which one should I use?" decision table - "New to ABsmartly?" suggested reading path - Mention LaunchPad + Product Documentation for non-developer paths
…I link - Rename section heading "APIs & SDKs" -> "Developer Tools" - Fix Platform API link (was incorrectly pointing at the Collector API) - Add MCP Server to the section bullet list - Update "what to do next" footer to match
1 participant
What
Adds a new MCP Server section under Product Documentation, mirroring the absmartly/mcp README.
Pages
Claude Desktop, Claude Code, Cursor, Windsurf, VS Code, Gemini (CLI + Code Assist + Enterprise), ChatGPT, DXT extension
Authorizationheader formats, local stdio, security modeldiscover_commands,get_command_docs,execute_command,get_auth_status, command groups, resources, promptsEditorial notes
@theme/Tabswith a sharedgroupId, so picking "OAuth" once selects it across every client sectionvscode:,vscode-insiders:,cursor://) wrapped in<BrowserOnly>— Docusaurus 2.4.3's broken-link checker doesn't recognize custom URI schemes, this defers rendering to the clientabsmartly/mcp/docs/images/Build
npm run buildpasses clean.Follow-ups (not in this PR)
docs/mcp-features.md(describes a previous 3-meta-tool architecture) with the current READMESummary by CodeRabbit