Ecosystem Contribution Guide
Use this guide for adding QVeris recipes, skills, plugins, or marketplace listing metadata.
Add A Recipe#
- Create a directory under
recipes/<kebab-case-name>/. - Add
README.mdwith a copy-paste complete CLI path and a Python SDK path when relevant. - Add
qveris.manifest.jsonusingecosystem/manifest.schema.json. - Declare every permission needed by the workflow:
capability.discoverfor finding capabilities.capability.inspectfor reading parameter, billing, and quality metadata.capability.callonly when the recipe executes a capability.capability.auditwhen the recipe reads usage history or credits ledger data.
- Add marketplace fields that can be consumed by a future listing service.
- Run
node scripts/validate-ecosystem-manifests.mjs.
Metadata Rules#
- Keep
idstable once published. - Use semver for
version. - Set
statustoexperimental,beta, orstable. - Keep
summaryunder 160 characters. - Prefer product-neutral use-case language in
marketplace.use_cases. - Do not declare a permission unless the workflow needs it.
Compatibility#
Update compatibility.md when a recipe requires a newer CLI, MCP, Python SDK, skill, or plugin surface.
Review Checklist#
- Manifest validates locally.
- README commands are copy-paste complete.
- Example paths in the manifest exist.
- Permission reasons explain the user-facing need.
- Marketplace fields are suitable for website ingestion without rewriting.