Skip to content

docs: a documentation site at fuseraft.ai/sql-mcp - #13

Merged
fuseraft merged 2 commits into
masterfrom
docs/site
Oct 20, 2026
Merged

fuseraft merged 2 commits into
masterfrom
docs/site

Conversation

@fuseraft

Copy link
Copy Markdown
Owner

sql-mcp's only documentation was a 468-line README. This adds a Starlight site in docs/, built and deployed the same way as anchor's, and served at https://fuseraft.ai/sql-mcp/ once merged. GitHub Pages is already turned on for the repo, with GitHub Actions as its source.

Pages

  • Start here: Install (source, self-contained binary, Docker), Quickstart (a Postgres database from read-only login to first question), Connect a client (stdio and HTTP for Claude Code, anchor and fuseraft, tokens, Origin, curl).
  • Guides:
    • Read-only logins: creating one per provider, what the audit refuses, and what it can't see.
    • Working with agents: the usual call sequence, and how comments, foreign keys and statistics help.
    • Deployment, Logging and Development.
  • Reference: Tools (all five, every argument and result), Configuration (every setting, connection strings, startup validation, environments), HTTP and command line.
  • How queries stay read-only: the three layers, and what an agent can still do.

README. It now gives the overview, install, configure and connect, and links to the site for the rest, like anchor's.

Workflow. .github/workflows/docs.yml is anchor's, with master for main. Pull requests that touch docs/ build the site, and pushes to master deploy it.

I checked behavior the pages describe against the code and a running server:

  • the /api/query problem response, the 403 for a foreign Origin, and settings on the command line (--App:MaxRows=2);
  • the audit's log line, and the default environment when none is set (Production, since there's no launchSettings.json).

The site builds cleanly, and every internal link and #anchor resolves. I looked at the landing page and a reference page in a browser.

A Starlight site in docs/, deployed to GitHub Pages like anchor's: start-here pages
(install, quickstart, connecting clients), guides (read-only logins, working with
agents, deployment, logging, development), references for the tools, configuration
and HTTP endpoints, and how queries stay read-only.

The README now gives the overview and links to the site for the detail it used to
carry.
@fuseraft
fuseraft merged commit 553e8d6 into master Oct 20, 2026
4 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