@synthbrew/agent lets MCP-capable agents create Synthbrew projects, validate schema configs, provision generated sources, create source API keys, and return runtime API docs.
Install
Most MCP clients can launch the package directly withnpx:
Environment variables
MCP config
SYNTHBREW_API_URL to your local API base:
Agent workflow
The calling agent drafts the schema itself, then uses Synthbrew tools to validate and provision resources:- Draft a canonical Synthbrew
schemaVersionConfigusingschemaConfigVersion: "v1"andformatVersion: 1. - Call
synthbrew_validate_schema_config. - Fix validation errors and validate again.
- List or create a project.
- Create a schema.
- Create and populate a source.
- Create a source API key.
- Get runtime docs and return app integration examples.
- Fetch sample rows when the user wants to inspect generated data or needs realistic example payloads.
Schema config v1
The public agent contract is frozen asschemaConfigVersion: "v1". The schema config payload uses formatVersion: 1.
Synthbrew may add optional fields, enum values, generation settings, and metadata fields to v1 without a new version. Synthbrew will not remove fields, rename fields, change existing meanings, or make optional fields required without introducing a new contract version.
Validation requests can include the contract version explicitly:
Example prompts
Use prompts that describe the product or workflow you are building. The agent will turn the request into a Synthbrew schema, validate it, create the source, and return the details your app needs.Existing app schema
Point your coding agent at the schema files your app already uses when you want Synthbrew data that matches your local models:SaaS analytics backend
Marketplace demo data
CRM and sales pipeline
Available tools
synthbrew_validate_schema_configsynthbrew_list_projectssynthbrew_create_projectsynthbrew_list_schemassynthbrew_create_schemasynthbrew_list_schema_versionssynthbrew_list_sourcessynthbrew_create_sourcesynthbrew_regenerate_sourcesynthbrew_get_generation_jobsynthbrew_list_generation_eventssynthbrew_list_source_api_keyssynthbrew_create_source_api_keysynthbrew_get_runtime_docssynthbrew_get_source_sample_data