write-script-graphql_skill

Overview

This skill helps you write and integrate GraphQL queries and mutations into scripts for a workflow platform. It focuses on correct operation structure, variable binding from script arguments, and the deployment steps required to make GraphQL-backed scripts runnable and self-hostable.

How this skill works

You author GraphQL queries or mutations in script files and declare variables as operation parameters. The script runner automatically binds script arguments to GraphQL variables, so inputs flow directly into queries and mutations. After writing, generate metadata and lock files with a CLI command and push the script to deploy it to the platform.

When to use it

• When a script needs to fetch structured data via GraphQL queries.
• When a script must perform create/update operations using GraphQL mutations.
• When you want to pass runtime inputs into GraphQL using script arguments.
• When integrating GraphQL endpoints into webhooks, workflows, or UIs.
• When preparing scripts for deployment and orchestration on the platform.

Best practices

• Name operations (query/mutation) clearly to aid debugging and logging.
• Use GraphQL variables instead of interpolating values to keep queries safe and reusable.
• Provide sensible default values for variables where applicable to simplify calls.
• Run wmill script generate-metadata after changes to update .script.yaml and lock files.
• Use wmill resource-type list --schema to discover and match available resource types before coding.

Example use cases

• Query a user by ID: define GetUser($id: ID!) to fetch id, name, email.
• Search products with pagination: use variables for search string and limit/defaults.
• Create a record via mutation: pass an input object into CreateUser mutation and return created fields.
• Wire a GraphQL query into a webhook to return dynamic responses based on request args.
• Embed queries into UI components or workflows to power low-code interfaces.