Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -239,26 +239,20 @@ export default defineConfig({
},
],
sidebar: [
{
label: 'About',
translations: { de: 'Ueber FlowMCP' },
collapsed: true,
items: [
// Memo 142 (REMOVE): FAQ, Use Cases, Schemas & Sources moved to
// .trash/memo-142-reduction (default-out reduction principle).
{ label: 'About FlowMCP', translations: { de: 'Ueber FlowMCP' }, slug: 'about' },
],
},
// Memo 144 K7 (T9): the standalone "About" group is merged INTO "Get Started"
// (it was a single-item group; About FlowMCP is the natural first onboarding step).
// Memo 059 PRD-011: Quickstart + Guides merged into "Get Started" (B3/B7).
// Inline-Listing (Variant A) — flat list, no sub-group. AC-3: exactly 4 items.
// Inline-Listing (Variant A) — flat list, no sub-group.
// PRD-013 audit: DE-Mirror via Starlight `translations` keys — both locales
// render 6 groups with localized labels (Loslegen, Konzepte, etc.).
// render with localized labels (Loslegen, Konzepte, etc.).
// Memo 060 PRD-016 (QS3 + LM1): "Quickstart" -> "CLI Setup", For LLMs aufgenommen.
{
label: 'Get Started',
translations: { de: 'Loslegen' },
collapsed: true,
items: [
// Memo 144 K7 (T9): About FlowMCP merged in from the removed standalone group.
{ label: 'About FlowMCP', translations: { de: 'Ueber FlowMCP' }, slug: 'about' },
// Memo 060 PRD-016 (QS3): "Quickstart" -> "CLI Setup" (DE bewusst englisch, analog "Tag Search").
// Memo 142 (REMOVE): Hackathon Kit, Agent Creation, GTFS Pilot -> .trash/memo-142-reduction.
{ label: 'CLI Setup', translations: { de: 'CLI Setup' }, slug: 'quickstart/quickstart' },
Expand Down
15 changes: 7 additions & 8 deletions public/spec-generated/docs-payload/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ spec_file: "00-overview.md"
order: 0
section: "Specification"
normative: false
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/00-overview.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/00-overview.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/00-overview.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/00-overview.md."
Expand All @@ -21,7 +21,6 @@ FlowMCP is a **Tool Catalog with pre-built API templates** and a **Knowledge Bas

This document provides the conceptual foundation, positioning, terminology, and document index for the v4.3.0 specification.

---

## Conformance Language

Expand Down Expand Up @@ -383,8 +382,8 @@ The migration path from v1.2.0 to v2.0.0 is documented in `08-migration.md`.

## Related

- [01-schema-format.md](/specification/schema-format/)
- [06-agents.md](/specification/agents/)
- [17-selections.md](/specification/selections/)
- [15-catalog.md](/specification/catalog/)
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [06-agents.md](/specification/agents/) — how an agent bundles tools, a model, and a prompt into one composition.
- [17-selections.md](/specification/selections/) — a named bundle of primitives an agent activates together.
- [15-catalog.md](/specification/catalog/) — the registry.json manifest that groups schemas, lists, and agents.

21 changes: 10 additions & 11 deletions public/spec-generated/docs-payload/01-schema-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "01-schema-format.md"
order: 1
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/01-schema-format.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/01-schema-format.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/01-schema-format.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/01-schema-format.md."
---

A FlowMCP schema is a single `.mjs` module that describes how to reach an API and turn its endpoints into tools. It splits into two named exports: a static, JSON-serializable `main` block that holds all declarative configuration, and an optional `handlers` factory that transforms requests and responses. The sections below walk through both exports, the tool and field definitions inside `main`, the naming conventions, and the constraints the runtime enforces at load time.

---

## Schema File Structure

Expand Down Expand Up @@ -680,11 +679,11 @@ export const handlers = ( { sharedLists } ) => ({

## Related

- [00-overview.md](/specification/overview/)
- [02-parameters.md](/specification/parameters/)
- [04-output-schema.md](/specification/output-schema/)
- [13-resources.md](/specification/resources/)
- [14-skills.md](/specification/skills/)
- [16-id-schema.md](/specification/id-schema/)
- [19-mcp-integration.md](/specification/mcp-integration/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [02-parameters.md](/specification/parameters/) — how a parameter places a value and validates it before the call.
- [04-output-schema.md](/specification/output-schema/) — how a route declares its expected response shape.
- [13-resources.md](/specification/resources/) — local SQLite and Markdown data access alongside network tools.
- [14-skills.md](/specification/skills/) — reusable instruction sets an agent can load and follow.
- [16-id-schema.md](/specification/id-schema/) — the canonical namespace/type/name identifier for every primitive.
- [19-mcp-integration.md](/specification/mcp-integration/) — the per-tool meta block and its mapping to MCP annotations.

17 changes: 8 additions & 9 deletions public/spec-generated/docs-payload/02-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "02-parameters.md"
order: 2
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/02-parameters.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/02-parameters.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/02-parameters.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/02-parameters.md."
---

A parameter declares where a value is placed in the outgoing API request and how it is validated before the call is made. Each tool parameter pairs a `position` block (placement) with a `z` block (validation); resource parameters reuse the same pairing without a `location` field, and skill input uses a simpler shape.

---

## Parameter Structure

Expand Down Expand Up @@ -640,9 +639,9 @@ See `14-skills.md` for the complete skill specification.

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [03-shared-lists.md](/specification/shared-lists/)
- [04-output-schema.md](/specification/output-schema/)
- [18-prefill.md](/specification/prefill/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [03-shared-lists.md](/specification/shared-lists/) — versioned value sets that schemas reference instead of duplicating.
- [04-output-schema.md](/specification/output-schema/) — how a route declares its expected response shape.
- [18-prefill.md](/specification/prefill/) — placeholder substitution and pre-executed tool calls in skill content.

19 changes: 9 additions & 10 deletions public/spec-generated/docs-payload/03-shared-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "03-shared-lists.md"
order: 3
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/03-shared-lists.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/03-shared-lists.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/03-shared-lists.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/03-shared-lists.md."
---

Shared lists eliminate duplication of common value sets across schemas. Instead of every Etherscan schema maintaining its own chain list, they reference a single `evmChains` shared list that is versioned, validated, and centrally maintained. The sections below cover the list file format, the meta and field definitions, the dependency model between lists, how schemas reference and filter lists, how the runtime injects resolved data into handlers, and the validation rules that keep the registry consistent.

---

## Purpose

Expand Down Expand Up @@ -555,10 +554,10 @@ Each `.mjs` file contains exactly one shared list. Combining multiple lists in a

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [02-parameters.md](/specification/parameters/)
- [15-catalog.md](/specification/catalog/)
- [16-id-schema.md](/specification/id-schema/)
- [09-validation-rules.md](/specification/validation-rules/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [02-parameters.md](/specification/parameters/) — how a parameter places a value and validates it before the call.
- [15-catalog.md](/specification/catalog/) — the registry.json manifest that groups schemas, lists, and agents.
- [16-id-schema.md](/specification/id-schema/) — the canonical namespace/type/name identifier for every primitive.
- [09-validation-rules.md](/specification/validation-rules/) — the wayfinder mapping each rule family to its home page.

19 changes: 9 additions & 10 deletions public/spec-generated/docs-payload/04-output-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "04-output-schema.md"
order: 4
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/04-output-schema.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/04-output-schema.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/04-output-schema.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/04-output-schema.md."
---

Output schemas make tool responses predictable. By declaring the expected shape of a response at the route level, an AI client knows in advance what fields it will receive and can reason about them without parsing guesswork. The sections below cover the output declaration format, the supported types and MIME-types, the standard response envelope, how output interacts with `postRequest` handlers, and the validation rules applied to every declaration.

---

## Purpose

Expand Down Expand Up @@ -517,10 +516,10 @@ The diagram shows the non-blocking validation flow: mismatches produce warnings

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [02-parameters.md](/specification/parameters/)
- [10-tests.md](/specification/tests/)
- [22-scoring-protocol.md](/specification/scoring-protocol/)
- [19-mcp-integration.md](/specification/mcp-integration/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [02-parameters.md](/specification/parameters/) — how a parameter places a value and validates it before the call.
- [10-tests.md](/specification/tests/) — executable examples that document tools and capture real responses.
- [22-scoring-protocol.md](/specification/scoring-protocol/) — the JSON formats exchanged between the CLI and an external grader.
- [19-mcp-integration.md](/specification/mcp-integration/) — the per-tool meta block and its mapping to MCP annotations.

17 changes: 8 additions & 9 deletions public/spec-generated/docs-payload/05-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "05-security.md"
order: 5
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/05-security.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/05-security.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/05-security.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/05-security.md."
---

FlowMCP enforces a layered security model that prevents schema files from accessing the network, filesystem, or process environment. All potentially dangerous operations are restricted to the trusted core runtime. Dependencies are injected through a factory function pattern, and external libraries are gated by an allowlist.

---

## Trust Boundary

Expand Down Expand Up @@ -352,9 +351,9 @@ All violations in a single file are reported together (the scan does not stop at

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [09-validation-rules.md](/specification/validation-rules/)
- [13-resources.md](/specification/resources/)
- [23-license-and-tos.md](/specification/license-and-tos/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [09-validation-rules.md](/specification/validation-rules/) — the wayfinder mapping each rule family to its home page.
- [13-resources.md](/specification/resources/) — local SQLite and Markdown data access alongside network tools.
- [23-license-and-tos.md](/specification/license-and-tos/) — the three-layer model linking code, provider ToS, and data licenses.

21 changes: 10 additions & 11 deletions public/spec-generated/docs-payload/06-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "06-agents.md"
order: 6
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/06-agents.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/06-agents.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/06-agents.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/06-agents.md."
---

An Agent is a complete, purpose-driven definition that bundles tools from multiple providers for a specific task. Unlike a plain tool list, an Agent is a full composition: it cherry-picks tools across providers, binds them to a specific LLM, defines a system prompt and behavioral guidelines, and ships with its own tests, explanatory prompts, instructional skills, and optional resources. The sections below cover the agent manifest format, how tool references are resolved, model binding, the system prompt, integrity verification through hashes, and the validation rules applied at activation.

---

## Purpose

Expand Down Expand Up @@ -1069,11 +1068,11 @@ export const agent = {

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [12-prompt-architecture.md](/specification/prompt-architecture/)
- [14-skills.md](/specification/skills/)
- [17-selections.md](/specification/selections/)
- [16-id-schema.md](/specification/id-schema/)
- [10-tests.md](/specification/tests/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [12-prompt-architecture.md](/specification/prompt-architecture/) — the two-tier prompt system for provider and agent workflows.
- [14-skills.md](/specification/skills/) — reusable instruction sets an agent can load and follow.
- [17-selections.md](/specification/selections/) — a named bundle of primitives an agent activates together.
- [16-id-schema.md](/specification/id-schema/) — the canonical namespace/type/name identifier for every primitive.
- [10-tests.md](/specification/tests/) — executable examples that document tools and capture real responses.

15 changes: 7 additions & 8 deletions public/spec-generated/docs-payload/07-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ spec_file: "07-tasks.md"
order: 7
section: "Specification"
normative: true
source_commit: "42b4603"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/42b4603/spec/v4.3.0/07-tasks.md"
generated_at: "2026-06-21T01:06:21.418Z"
source_commit: "55474a9"
source_url: "https://github.com/FlowMCP/flowmcp-spec/blob/55474a9/spec/v4.3.0/07-tasks.md"
generated_at: "2026-06-21T18:24:22.826Z"
generated_from: "spec/v4.3.0/07-tasks.md"
generator: "scripts/generate-docs-payload.mjs"
edit_warning: "This file is auto-generated. Source: spec/v4.3.0/07-tasks.md."
---

MCP Tasks describe long-running asynchronous operations — a query that takes thirty seconds to finish, a job that is submitted now and collected later. The underlying MCP protocol gives such operations a lifecycle of creation, polling, completion, and cancellation. FlowMCP does not yet model this lifecycle: task support is a reserved, forward-looking area of the specification, and this page documents what is held back and why.

---

## Why It Is Held Back

Expand All @@ -41,8 +40,8 @@ Schema authors MAY include an `async` field in tool definitions for forward comp

## Related

- [00-overview.md](/specification/overview/)
- [01-schema-format.md](/specification/schema-format/)
- [04-output-schema.md](/specification/output-schema/)
- [10-tests.md](/specification/tests/)
- [00-overview.md](/specification/overview/) — mission, the two-channel catalog, and the knowledge framing.
- [01-schema-format.md](/specification/schema-format/) — how a schema declares its tools through main and handlers.
- [04-output-schema.md](/specification/output-schema/) — how a route declares its expected response shape.
- [10-tests.md](/specification/tests/) — executable examples that document tools and capture real responses.

Loading
Loading