script: add docs API, MCP, and SSH

api/docs-json-api.md

@@ -0,0 +1,68 @@
+---
+title: Docs JSON API (Experimental)
+summary: Provide a structured JSON API for TiDB docs with topic and feature filters.
+---
+
+# Docs JSON API (Experimental)
+
+This API layer exposes structured metadata for markdown docs.
+
+## Why
+
+- Query docs by feature token (for example, `tidb_max_dist_task_nodes`)
+- Query docs by topic/category
+- Return structured schema instead of raw markdown only
+
+## Data schema
+
+Each doc record includes:
+
+- `id`
+- `path`
+- `title`
+- `summary`
+- `product`
+- `topics`
+- `features`
+- `headings`
+- `frontMatter`
+- `frontMatterRaw`
+- `updatedAt`
+
+## Build index
+
+```bash
+npm run docs-api:build
+```
+
+Default output file: `tmp/docs-api-index.json`
+
+## Run API server
+
+```bash
+npm run docs-api:serve
+```
+
+Default host and port: `127.0.0.1:3000`
+
+## Endpoints
+
+- `GET /healthz`
+- `GET /schema`
+- `GET /topics`
+- `GET /features`
+- `GET /features?prefix=tidb_`
+- `GET /docs`
+- `GET /docs?feature=tidb_max_dist_task_nodes`
+- `GET /docs?topic=tidb-cloud`
+- `GET /docs?q=resource control`
+- `GET /docs?feature=tidb_max_dist_task_nodes&limit=10&offset=0`
+- `GET /reload` (reload in-memory index)
+
+## Environment variables
+
+- `DOCS_API_HOST` (default `127.0.0.1`)
+- `DOCS_API_PORT` (default `3000`)
+- `DOCS_API_ROOT` (default current working directory)
+- `DOCS_API_INDEX_FILE` (optional prebuilt JSON index path)
+

package.json

@@ -4,6 +4,10 @@
   "main": "index.js",
   "license": "MIT",
   "type": "module",
+  "scripts": {
+    "docs-api:build": "node scripts/build-docs-api-index.js",
+    "docs-api:serve": "node scripts/docs-api-server.js"
+  },
   "dependencies": {
     "axios": "^1.4.0",
     "glob": "^8.0.3",

scripts/build-docs-api-index.js

@@ -0,0 +1,22 @@
+import * as fs from "fs";
+import path from "path";
+import { buildDocsIndex } from "./docs-api-lib.js";
+
+const args = process.argv.slice(2);
+const outputArg = args[0] || "tmp/docs-api-index.json";
+const rootArg = args[1] || process.cwd();
+
+const outputPath = path.resolve(outputArg);
+const outputDir = path.dirname(outputPath);
+
+if (!fs.existsSync(outputDir)) {
+  fs.mkdirSync(outputDir, { recursive: true });
+}
+
+const index = buildDocsIndex(rootArg);
+fs.writeFileSync(outputPath, JSON.stringify(index, null, 2), "utf8");
+
+console.log(
+  `Docs API index generated: ${outputPath} (${index.totalDocs} docs, ${index.features.length} features)`
+);
+