Skip to content

Point long-form docs at docs.mainwp.com/mcp-server - #53

Merged
dennisdornon merged 2 commits into
mainfrom
docs-site-pointers
Jul 22, 2026
Merged

dennisdornon merged 2 commits into
mainfrom
docs-site-pointers

Conversation

@dennisdornon

@dennisdornon dennisdornon commented Jul 22, 2026 •

Copy link
Copy Markdown
Member

What changed

User documentation moved to a dedicated section on the docs site (https://docs.mainwp.com/mcp-server/overview, shipped in mainwp/docs#99). This PR makes the repo point there instead of duplicating it.

  • README: 969 → 163 lines. Keeps the intro, Quick Start (Application Password steps, one config block, first-prompt check), the complete environment-variable table, a tools category summary, a short safety section, and Contributing. The per-client installation blocks, per-tool catalog, confirmation-flow deep dive, and token-usage section are now links to their canonical docs-site pages.
  • Env table is now complete: all 21 variables (previously 17 of 21; MAINWP_RATE_LIMIT, MAINWP_REQUEST_TIMEOUT, MAINWP_MAX_RESPONSE_SIZE, MAINWP_MAX_SESSION_DATA were only in docs/configuration.md). It matches the docs-site configuration reference, and Contributing notes the two are maintained in parallel.
  • docs/configuration.md, security.md, troubleshooting.md, example-prompts.md: replaced with short stubs linking to their docs-site pages. Files kept so existing inbound links resolve.
  • docs/acceptance-testing.md: unchanged (contributor material, repo-only).

No code changes.

Verification

  • npm run format:check, npm run lint, npm test (664 passed), npm run build all pass
  • Every docs-site URL referenced was checked live, including the redirect from the old page and the new section's presence in llms.txt

Summary by CodeRabbit

  • Documentation
    • Reworked and shortened the README with a clearer local setup flow, streamlined “Quick Start,” and a new Safety overview (including default destructive-operation confirmation).
    • Expanded environment-variable guidance (rate/timeout, max response/session sizes) and clarified that environment variables override settings.json; improved SSL verification warning text.
    • Reduced the Tools section to high-level rules and added links for tool restriction/filtering.
    • Moved configuration, security, troubleshooting, and example prompts to dedicated MainWP documentation pages.

The user documentation now lives on the MainWP docs site
(docs.mainwp.com/mcp-server, mainwp/docs PR #99). The README shrinks
from 969 to about 170 lines: per-client installation blocks, the
per-tool catalog, the confirmation-flow deep dive, and the token-usage
section become links to their canonical pages. The environment-variable
table is now complete (21 variables, previously 17 of 21) and matches
the docs-site configuration reference; the Contributing section notes
the two are maintained in parallel.

docs/configuration.md, security.md, troubleshooting.md, and
example-prompts.md become stubs linking to their docs-site pages so
existing inbound links keep resolving. docs/acceptance-testing.md is
unchanged; it is contributor material and stays repo-only.
@coderabbitai

coderabbitai Bot commented Jul 22, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7c773a15-3e18-4379-ae5c-4e137baff352

📥 Commits

Reviewing files that changed from the base of the PR and between 2829c27 and d50dca7.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README is shortened and reorganized around onboarding, configuration, tools, and safety. Detailed configuration, prompt, security, and troubleshooting content is replaced with links to MainWP documentation.

Changes

Documentation consolidation

Layer / File(s) Summary
Streamline README guidance
README.md
Adds local-server and safety guidance, simplifies setup instructions, documents additional environment variables, clarifies configuration precedence, and condenses tool and safety sections.
Redirect detailed guides
docs/configuration.md, docs/example-prompts.md, docs/security.md, docs/troubleshooting.md
Replaces detailed in-repository guides with links to the corresponding MainWP documentation pages.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • mainwp/mainwp-mcp#8: Updates overlapping README, configuration, and security documentation around safety and tool filtering.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: redirecting long-form documentation to the docs.mainwp.com/mcp-server site.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-site-pointers

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 23: Update the README statements about destructive operations and
confirmation to say that, by default, operations classified as destructive
require user confirmation, reflecting the MAINWP_REQUIRE_USER_CONFIRMATION
setting and annotation-based classification without implying an unconditional
guarantee.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 600ee406-e6f9-4440-9ad3-ff24f1618b48

📥 Commits

Reviewing files that changed from the base of the PR and between 7854e14 and 2829c27.

📒 Files selected for processing (5)
  • README.md
  • docs/configuration.md
  • docs/example-prompts.md
  • docs/security.md
  • docs/troubleshooting.md

Comment thread README.md Resolved
Confirmation applies by default and can be disabled with
MAINWP_REQUIRE_USER_CONFIRMATION=false, and destructiveness is
annotation-classified rather than limited to deletions. Say so instead
of implying an unconditional guarantee.
@dennisdornon
dennisdornon merged commit 4365a0d into main Jul 22, 2026
6 checks passed
@dennisdornon
dennisdornon deleted the docs-site-pointers branch October 6, 2026 21:54
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.

1 participant