Skip to content

FlowMCP/flowmcp.github.io

Repository files navigation

flowmcp.github.io — Documentation Site

The FlowMCP v4 documentation, specification, and ecosystem overview. Built with Astro using the Starlight theme.

Live: flowmcp.github.io (auto-deployed via GitHub Pages on push to main).

Architecture

flowmcp.github.io/
├── src/
│   └── content/
│       ├── docs/                  ← MD/MDX pages (Astro Content Collection)
│       │   └── specification/     ← Spec files synced from flowmcp-spec
│       └── config.ts              ← Schema definitions
├── public/                        ← Static assets, llms.txt
├── scripts/
│   └── sync-spec.mjs              ← Spec sync script (lokal + GitHub Action)
└── .github/workflows/
    └── sync-spec.yml              ← Sync-Spec auf push + repository_dispatch

Spec-Auto-Generation (Hybrid A+B)

Specification documents from flowmcp-spec (spec/v4.0.0/*.md) are auto-synced into src/content/docs/specification/.

Two triggers:

  • GitHub Action on push to main → always syncs before build
  • GitHub Action on repository_dispatch (event-type spec-updated) → triggered from flowmcp-spec push
  • Local via npm run sync-spec for manual updates

The same scripts/sync-spec.mjs is used in both Action and local — single source of truth.

Local Development

npm ci
npm run sync-spec        # Sync spec files from flowmcp-spec
npm run dev              # Astro dev server on localhost:4321
npm run build            # Static build to dist/ (109+ pages)

Content Sources

Section Source
Specification Auto-synced from flowmcp-spec spec/v4.0.0/*.md
Guides, Intro, Roadmap Locally edited in src/content/docs/
Schema Catalog Auto-generated from flowmcp-schemas-public
llms.txt Auto-generated by flowmcp-spec workflow

Related Repositories

Repository Description
flowmcp-spec Specification — source of truth for spec docs
flowmcp-core Core framework
flowmcp-cli CLI tooling
flowmcp-schemas-public Public schema library

License

MIT. Content is built from MIT-licensed sources. Third-party API documentation referenced in the docs site does not imply endorsement or warranty — see provider Terms of Services for use.

About

FlowMCP v4 documentation, specification, and ecosystem overview

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors