enh: Readme Consolidation - #989
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README was substantially reorganized and condensed. It now presents service, quick-start, client connection, CLI, deployment, security, development, and licensing guidance in a shorter documentation-focused structure. ChangesREADME documentation restructure
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 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: 2
🤖 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 `@README.md`:
- Line 254: Rename the later “Security & Compliance” heading in the condensed
section to a unique title such as “Security Notes” or “Security Quick
Reference,” while leaving the detailed heading and surrounding content
unchanged.
- Line 51: Correct the misspelled “webiste” text to “website” in the README
sentence describing the extensive documentation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| The **[Advanced Deployment guide](https://workspacemcp.com/docs/deployment)** covers self-hosting specifics: reverse proxy setup with `WORKSPACE_EXTERNAL_URL` (including the nginx `Origin: null` consent workaround and `Referrer-Policy` pitfall), origin validation and VS Code webview allowlisting, credential store backends (local directory or GCS with CMEK enforcement), and the **[complete environment variable reference](https://workspacemcp.com/docs/deployment#environment-variables)**. | ||
|
|
||
| Example: | ||
| ## Security & Compliance |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Rename the duplicate "Security & Compliance" heading.
Line 61 already defines a "Security & Compliance" heading with a detailed table. Line 254 repeats the same heading text for a condensed section. Duplicate headings with identical text break anchor-link uniqueness and confuse navigation. Rename the second heading, for example to "Security Notes" or "Security Quick Reference".
🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 254-254: Multiple headings with the same content
(MD024, no-duplicate-heading)
🤖 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 `@README.md` at line 254, Rename the later “Security & Compliance” heading in
the condensed section to a unique title such as “Security Notes” or “Security
Quick Reference,” while leaving the detailed heading and surrounding content
unchanged.
Source: Linters/SAST tools
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Revised description to enhance clarity and accuracy regarding features and capabilities of the Workspace MCP server.
Updated PyPI Downloads badge to use 'NONE' units.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@README.md`:
- Line 17: Update the README description near the Google Workspace tooling claim
to hyphenate “built in integrations” as “built-in integrations,” leaving the
surrounding wording unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| *Includes a full featured CLI & Code Mode for use with tools like Claude Code and Codex!* | ||
|
|
||
| **The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built in integrations with Claude and ChatGPT can't even dream of. With Remote OAuth2.1 multi-user support, fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existance, Workspace MCP is in a different class. Offering native OAuth 2.1, stateless mode and external auth server support, it's also the only Workspace MCP you can host for your whole organization centrally & securely! | ||
| **The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built in integrations with Claude and ChatGPT can't come close to. With multi-user support, rich fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existence, Workspace MCP is in a different class. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add hyphen in "built-in integrations".
Line 17 reads "the built in integrations with Claude and ChatGPT". Use a hyphen: "built-in integrations".
✏️ Proposed fix
-**The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built in integrations with Claude and ChatGPT can't come close to. With multi-user support, rich fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existence, Workspace MCP is in a different class.
+**The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built-in integrations with Claude and ChatGPT can't come close to. With multi-user support, rich fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existence, Workspace MCP is in a different class. 📝 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.
| **The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built in integrations with Claude and ChatGPT can't come close to. With multi-user support, rich fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existence, Workspace MCP is in a different class. | |
| **The most feature-complete Google Workspace MCP server**, it can do things that Google's own tooling and the built-in integrations with Claude and ChatGPT can't come close to. With multi-user support, rich fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existence, Workspace MCP is in a different class. |
🧰 Tools
🪛 LanguageTool
[grammar] ~17-~17: Use a hyphen to join words.
Context: ... that Google's own tooling and the built in integrations with Claude and ChatGPT ...
(QB_NEW_EN_HYPHEN)
[style] ~17-~17: ‘in existence’ might be wordy. Consider a shorter alternative.
Context: ...e coverage of any Google Workspace tool in existence, Workspace MCP is in a different class....
(EN_WORDINESS_PREMIUM_IN_EXISTENCE)
🤖 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 `@README.md` at line 17, Update the README description near the Google
Workspace tooling claim to hyphenate “built in integrations” as “built-in
integrations,” leaving the surrounding wording unchanged.
Source: Linters/SAST tools
1 participant
Summary by CodeRabbit