Schema Lifecycle

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

Normative language (MUST/SHOULD/MAY) follows the conventions defined in Conformance Language.

Overview

Every FlowMCP schema passes through a defined lifecycle from initial research to production deployment. This document defines the six stages, special rules for static schemas and migrated schemas, and the policy for handling partially passing schemas.

Lifecycle Stages

Stage	Label	Entry Condition	Exit Condition
1	`stage:research`	API endpoint discovered	API reachable, schema creation is feasible
2	`stage:creation`	Research complete	Schema file created in `tests/new-schemas/`
3	`stage:api-test`	Schema created	`flowmcp test single` → min. 1 PASS (see Special Rule)
4	`stage:validation`	API test passed	`flowmcp validate` → 0 errors
5	`stage:grade`	Validation passed	Grade B or better
6	`stage:production`	Grade B+ confirmed	Deployed to `providers/` in production catalog

Stage Details

stage:research — The API has been identified as a candidate. The developer verifies that the endpoint is reachable and that the schema design is feasible (authentication model, response format, parameter structure).

stage:creation — The schema file is written and placed in tests/new-schemas/{provider}/. This stage covers the authoring process — defining tools, parameters, shared list references, handlers, and test cases.

stage:api-test — The schema is tested against the live API using flowmcp test single <path>. At least one tool must return a PASS result. See the API-Test Special Rule below for schemas with no HTTP tools.

stage:validation — The schema passes structural validation: flowmcp validate <path> returns 0 errors. All validation rules from 09-validation-rules.md must be satisfied.

stage:grade — The schema receives a quality grade. Grade B or better is required for production deployment. See the Grading-Spec 2.0.0 for the grading criteria — FlowMCP delegates the grading model to this standard.

stage:production — The schema is moved from tests/new-schemas/ to providers/{namespace}/ in the production catalog and registered in registry.json.

API-Test Special Rule for Static Schemas

Not all schemas make HTTP calls. A schema is considered static when all of its primitives are non-HTTP:

Schema Type	Has HTTP?	API-Test Required?
At least 1 Tool or HTTP-Resource	Yes	Yes — min. 1 PASS required
Exclusively Prompts / static Skills	No	Auto-PASS — stage skipped

Static schemas — schemas that contain only Prompts and/or static Skills (no Tools, no HTTP-Resource) — receive an automatic PASS for stage:api-test. There is no live API to test against. The stage is considered complete and the schema proceeds directly to stage:validation.

Note: In practice, static schemas are rare. The primary use case is future Prompt-only schemas or documentation-only namespaces. Most schemas in the community catalog contain at least one Tool.

Migration schemas — schemas migrated from v3 that contain only static primitives also receive Auto-PASS. See Migration Special Rule.

Migration Special Rule

Schemas migrated from v3.0.0 to v4.0.0 do not need to repeat the full lifecycle from scratch:

Migrated schemas start at stage:api-test (not stage:research)
The research and creation stages are considered complete by virtue of the existing v3 schema
All subsequent stages (stage:api-test through stage:production) apply normally

This shortens the migration path: a previously passing v3 schema that has been updated to v4 syntax needs only an API test, validation pass, and grade check before it can re-enter production.

Partial Schema Policy

Core Rule

All failing primitives MUST be removed before a schema is deployed to production. A schema with failing tools, resources, or skills cannot enter stage:production.

Rationale: An LLM working with a schema assumes that every registered primitive is functional. If getTokenPrice is listed but always errors, the agent has no way to know — it will attempt the call, fail, and potentially produce incorrect results. Removing failing primitives eliminates silent failures at the cost of reduced coverage.

Example: Before and After

// BEFORE — etherscan-io/contracts.mjs with 3 tools, 1 failing
tools: {
    getContractAbi: { /* ... */ },      // PASS — keep
    getSourceCode: { /* ... */ },       // PASS — keep
    getCreationCode: { /* ... */ }      // FAIL — remove before production
}

// AFTER — ready for production
tools: {
    getContractAbi: { /* ... */ },      // PASS
    getSourceCode: { /* ... */ }        // PASS
}
// getCreationCode removed — tracked as separate sub-issue

Threshold

There is no percentage threshold. Each failing primitive is evaluated individually:

1 of 8 tools failing → remove the 1 failing tool, deploy the 7 passing tools
3 of 5 tools failing → remove 3 failing tools, deploy 2 passing tools
All tools failing → schema does not deploy (no primitives remain)

The threshold-free policy prevents edge cases where a “60% pass rate” is considered acceptable. Either a primitive works or it does not.

What Happens to Removed Primitives

Removed primitives are not abandoned — they are tracked for future resolution:

Sub-Issue created — A GitHub issue is opened for each removed primitive. The issue is linked to the parent schema issue.
Backlog stage — The removed primitive starts at stage:research (with the API reachability already known).
Resolution path — When the underlying issue is fixed (changed API, missing auth, updated handler), the primitive is re-added to the schema and goes through stage:api-test → stage:validation → stage:grade.
Re-integration — The fixed primitive is merged back into the production schema. A new grade check may be required if the primitive significantly changes the schema’s scope.

What Counts as Failing

A primitive fails the API test when:

The HTTP response is a non-2xx status code (authentication error, rate limit, deprecated endpoint)
The response does not match the declared output.schema
The handler throws an uncaught exception
The tool times out consistently (> 30 seconds)

A primitive passes when at least one of its test cases returns a 2xx response with a parseable body that matches the declared output shape.

Depends on: 00-overview.md
Related: 20-validation-strategy.md, 22-scoring-protocol.md, 10-tests.md, 09-validation-rules.md, 15-catalog.md