lilygo-doc-mcp

MCP server for LILYGO product documentation. Exposes LILYGO hardware docs as structured tools for LLM clients via the Model Context Protocol.

Documentation is served from a local git submodule of Xinyuan-LilyGO/documentation. No runtime GitHub API calls — zero rate limit issues. Docs stay up-to-date automatically via a GitHub webhook.

Quick start

1. Clone with submodule

git clone --recurse-submodules https://github.com/your-org/lilygo-doc-mcp
cd lilygo-doc-mcp
npm install
npm run build

If you cloned without --recurse-submodules, run:

npm run docs:init

2. Start the server

PORT=3000 npm start

3. Connect your MCP client

{
  "mcpServers": {
    "lilygo-docs": {
      "type": "streamable-http",
      "url": "http://localhost:3000/mcp"
    }
  }
}

Related MCP server: Godot Docs MCP

Keeping docs up to date

Manual update

npm run docs:update

Then restart the server (or let the webhook do it automatically).

Automatic via GitHub webhook

Set up a webhook on the Xinyuan-LilyGO/documentation repository:

1. Go to Settings → Webhooks → Add webhook

2. Set Payload URL to https://your-server.com/webhook

3. Set Content type to application/json

4. Set a Secret (any random string)

5. Choose Just the push event

Start the server with the webhook secret:

GITHUB_WEBHOOK_SECRET=your-secret PORT=3000 npm start

On every push to the documentation repo, the server will:

1. Run git submodule update --remote --merge vendor/docs

2. Reload the in-memory product cache

Endpoints

Tools

Environment variables

Docker

FROM node:22-alpine
WORKDIR /app
COPY . .
RUN npm ci && npm run build
EXPOSE 3000
CMD ["node", "dist/index.js"]

Build and run:

docker build -t lilygo-doc-mcp .
docker run -p 3000:3000 \
  -e GITHUB_WEBHOOK_SECRET=your-secret \
  lilygo-doc-mcp

License

MIT