Skip to content

docs: Cloud-first README + move internals to docs/#46

Merged
ChiragAgg5k merged 3 commits into
mainfrom
docs/readme-refactor
Jun 24, 2026
Merged

docs: Cloud-first README + move internals to docs/#46
ChiragAgg5k merged 3 commits into
mainfrom
docs/readme-refactor

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

What

Refactors the README to be straight-to-the-point for end users, centered on Appwrite Cloud, and moves the internal/reference documentation into a new docs/ folder.

Changes

README (Cloud-first, end-user focused)

  • Leads with the hosted server (https://mcp.appwrite.io/mcp) and browser OAuth.
  • Connect your client section with verified, copy-pasteable Cloud setup for Claude Code, Claude Desktop, Cursor, VS Code (Copilot), Codex, OpenCode, and Windsurf — each as a collapsible block. Config syntax confirmed against each client's official docs.
  • Self-hosted reduced to a small pointer block.
  • Centered Appwrite logo header (light/dark via <picture>).

New docs/ folder

  • tool-surface.md — operator surface + internal catalog
  • authentication.md — the Cloud OAuth 2.1 flow
  • documentation-search.mdappwrite_search_docs + index rebuild
  • self-hosted.md — per-client stdio setup with a project API key
  • development.md — running, testing, debugging (cross-links AGENTS.md)

Removed images

  • Deleted the four integration screenshots (cursor, claude-desktop, vs-code, windsurf). They were outdated — they showed the old 42-tool surface (contradicting the current compact ≤4-tool design) and the stdio/API-key flow, and leaked live APPWRITE_API_KEY values and user PII.
  • Kept the brand logos and put them to use in the README header.

Notes

  • No code changes — documentation and assets only.

- Trim README to end-user setup: hosted Cloud OAuth + per-client connect
  instructions (Claude Code/Desktop, Cursor, VS Code, Codex, OpenCode, Windsurf)
- Move reference material into docs/: tool-surface, authentication,
  documentation-search, self-hosted, development
- Drop outdated integration screenshots (showed the old 42-tool surface and
  leaked API keys/PII); keep brand logos and add a centered README header
@greptile-apps

greptile-apps Bot commented Jun 24, 2026

Copy link
Copy Markdown

Greptile Summary

This is a documentation-only refactor that rewrites the README to be Cloud-first and moves the detailed reference content into a new docs/ folder. No production code is touched.

  • README is trimmed to a quick-start focused on the hosted https://mcp.appwrite.io/mcp server, with collapsible per-client setup blocks for Claude Code, Claude Desktop, Cursor, VS Code, Codex, OpenCode, and Windsurf.
  • Five new docs/ pages cover authentication, tool surface, documentation search, self-hosted setup, and local development \u2014 each linked from the README.
  • Six images deleted: four integration screenshots (contained outdated tool counts and leaked API keys/PII) and the two brand logo PNGs; the final README contains no image references.

Confidence Score: 5/5

Safe to merge — all changes are documentation and assets with no effect on runtime behaviour.

The PR touches only Markdown files and binary images. The new docs correctly describe the server's existing behaviour, and the removed screenshots no longer leak credentials. The one nit in docs/self-hosted.md is a minor copy clarification that doesn't affect any running code.

The https:// endpoint placeholder in docs/self-hosted.md is worth a quick look — it could mislead local Docker users who follow the localhost:9501 example literally into using an HTTPS URL that will fail.

Important Files Changed

Filename Overview
README.md Refactored to Cloud-first with per-client collapsible setup blocks; no logo images present in the final file despite the PR description mentioning a <picture> header (already flagged in previous thread).
docs/self-hosted.md Complete per-client stdio setup; all configs use https:// in the endpoint template while the Setup section gives localhost:9501 as an example — these conflict for local Docker users.
docs/authentication.md New file documenting the OAuth 2.1 / PKCE flow with a Mermaid sequence diagram; content matches the authoritative description from the old README.
docs/development.md New file covering clone, run (Docker Compose + uv), testing, and debugging — correctly uses http://localhost:9501/v1 for the local dev endpoint.
docs/documentation-search.md New file documenting the appwrite_search_docs tool, runtime config variables, and index rebuild command — accurate and complete.
docs/tool-surface.md New file with a Mermaid flowchart and table describing the exposed vs internal tool surface; aligns with the server's documented behavior.

Reviews (2): Last reviewed commit: "(docs): simplify docs — trim redundant t..." | Re-trigger Greptile

Comment thread README.md Outdated
@ChiragAgg5k ChiragAgg5k merged commit 1fe1c72 into main Jun 24, 2026
5 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.

1 participant