Skip to content

feat: workflow yaml schema #358

Open
tribhuwan-kumar wants to merge 4 commits intomediar-ai:mainfrom
tribhuwan-kumar:yaml-schema
Open

feat: workflow yaml schema #358
tribhuwan-kumar wants to merge 4 commits intomediar-ai:mainfrom
tribhuwan-kumar:yaml-schema

Conversation

@tribhuwan-kumar
Copy link
Contributor

fix: #298

on demand schema generation if required:

cargo run --bin  generate-schema

include the schema in workflow file:

# yaml-language-server: $schema=../../../schema/workflow-schema.yaml # or github raw url
variables:
  extension_dir:
    default: "%TEMP%\\terminator-bridge"
    label: Folder to load (will be created by the download step)
    type: string
  release_url:
    default: https://github.com/mediar-ai/terminator/releases/latest/download/terminator-browser-extension.zip
    label: GitHub Release asset URL (zip)
    type: string
  zip_path:
    default: "%TEMP%\\terminator-browser-extension.zip"
    label: Path to downloaded zip
    type: string
    .................
    .................

@louis030195
Copy link
Contributor

not sure what's the use case?

@tribhuwan-kumar
Copy link
Contributor Author

tribhuwan-kumar commented Nov 14, 2025

the schema will provide a base for workflow file, follows the correct data type and validation!

  • validation: correct structure and data types, catching errors early before running the workflow.

  • autocompletion: editors like vscode with LSP support would provide autocompletion for fields via yaml shcema, it makes easier and faster to write valid yaml.

  • documentation: this schema will act as live documentation, describing what fields and values are allowed, reducing the need to constantly refer to external docs

  • error highlighting: invalid or missing fields are highlighted in real-time, it would help us to fix mistakes instantly

  • consistency: enforcing a schema ensures all workflow files across a project or organization follow the same conventions and standards

every standard workflow has their own schema, take a look at github action workflow schema https://www.schemastore.org/github-workflow.json

recording-2025-11-14-06-29-40.webm

vs code yaml LSP https://github.com/redhat-developer/vscode-yaml

@louis030195

@louis030195
Copy link
Contributor

thats cool

i think in the future we want to keep supporting both yaml and typescript but remove the MCP tools and make AI only use directly run_command and execute_sequence so let me a bit more time to think about it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

yaml schema for mcp tools

2 participants