CircleCI

These are the CircleCI actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Context

  Tool to create a new context in CircleCI. Contexts are used to secure and share environment variables across projects. Use this when you need to set up a new environment configuration for your CircleCI workflows.

• Create Context Restriction

  Tool to create a context restriction in CircleCI. Use when you need to limit context access based on project, expression rules, or group membership.

• Create Organization Project

  Tool to create a new project within a CircleCI organization. Use when you need to programmatically set up a new project for CI/CD automation.

• Create Project Environment Variable

  Tool to create a new environment variable for a CircleCI project. Use when you need to add a new environment variable that will be available in project builds.

• Delete Project Environment Variable

  Tool to delete an environment variable from a CircleCI project. Use when you need to remove an existing environment variable by name.

• Get Context

  Tool to retrieve a context by its unique ID. Use when you need details about a specific CircleCI context.

• Get Current User

  Tool to retrieve information about the currently authenticated user. Use when you need details about the signed-in user's profile, permissions, and account settings.

• Get Flaky Tests

  Tool to get flaky tests for a project. Use when you need to identify tests that passed and failed in the same commit. Branch-agnostic insights help improve test reliability.

• Get Orb Details

  Tool to query detailed information about a CircleCI orb using the GraphQL API. Use when you need to retrieve orb metadata, versions, usage statistics, or namespace details.

• Get Organization

  Tool to retrieve organization details from CircleCI using GraphQL query. Use when you need organization information by ID or by name and VCS type.

• Get Project

  Tool to retrieve a CircleCI project by its slug. Use when you need project details such as organization info, project ID, or VCS configuration.

• Get Project Workflows

  Tool to get summary metrics for all workflows of a project. Use when you need to analyze performance across all workflows, including success rates, duration metrics, throughput, and credits used.

• Get Workflow Summary

  Tool to get metrics and trends for a workflow. Use when you need workflow performance insights including success rates, duration metrics, and trends over time.

• List Context Environment Variables

  Tool to list all environment variables for a specific context. Use when you need to retrieve or paginate through environment variables stored in a CircleCI context.

• List Insights Branches

  Tool to get all branches for a project from CircleCI Insights. Use when you need to retrieve the list of branches that have workflow runs in the project.

• List Insights Summary

  Tool to get summary metrics with trends for the entire organization and for each project. Use when you need organization-wide performance analytics across all projects.

• List Orbs

  Tool to list CircleCI orbs with pagination support via GraphQL API. Use when you need to browse available orbs, filter by certification status, or discover orbs with their usage statistics. Returns up to 20 orbs per page with cursor-based pagination.

• List Organization Groups

  Tool to list all groups in a CircleCI organization. Use when you need to retrieve groups for an organization to manage permissions or view group memberships.

• List Pages Summary

  Tool to get summary metrics and trends for a project across its workflows and branches. Use when you need to analyze project performance, track success rates, throughput, credits usage, and duration trends.

• List Pipeline Definitions

  Tool to list all pipeline definitions for a specific project. Use when you need to retrieve available pipeline configurations for a project.

• List Pipelines

  Tool to get a list of pipelines for an organization. Use when you need to retrieve pipelines across multiple projects or for a specific organization.

• List Project Environment Variables

  Tool to list all environment variables for a CircleCI project. Use when you need to retrieve project-level environment variables. Note that values are masked for security.

• List Project Schedules

  Tool to list all schedules for a specific project. Use when you need to retrieve scheduled pipeline triggers for a project.

• List User Collaborations

  Tool to retrieve organizations where the authenticated user has access. Use when you need to list all organizations a user can collaborate on.

• List Workflows Jobs Workflows

  Tool to get summary metrics for a project workflow's jobs. Use when you need performance analytics like success rates, duration statistics, and credit usage for jobs in a specific workflow.

• List Workflows Test Metrics

  Tool to get test metrics for a project's workflows. Use when you need to analyze test performance, identify flaky tests, or find the slowest tests in a workflow.

• Query Context

  Tool to retrieve a CircleCI context by its UUID using GraphQL API. Use when you need to fetch context details including ID, name, and creation time. Returns null in the data field if the context ID does not exist.

• Query Plan Metrics

  Tool to query plan metrics including credit usage by project and organization for a date range. Use when you need to analyze credit consumption, compute time usage, or project-level metrics for an organization.

• Upsert Context Environment Variable

  Tool to add or update an environment variable in a CircleCI context. Use when you need to set or modify context-level environment variables for your CircleCI projects.

• Create Context (GraphQL)

  Tool to create a new CircleCI context using the GraphQL API. Use when you need to create a context for storing environment variables in CircleCI. The mutation returns error information if creation fails or payload data if successful.

• Create Organization Group

  Tool to create a group in an organization. Use when you need to organize users within a CircleCI organization by creating logical groups.

• Create Organization Orb Allowlist

  Tool to create a new URL Orb allow-list entry for an organization. Use when you need to allow URL-based orb references from specific URL prefixes in CircleCI pipelines for an organization.

• Create Usage Export Job

  Tool to create a usage export job for a CircleCI organization. Use when you need to export usage data for billing, analysis, or reporting purposes. Rate limited to 10 queries per hour. Maximum date window is 32 days, with up to 13 months of historical data available.

• Delete Context (GraphQL)

  Tool to delete a CircleCI context by its UUID using GraphQL API. Use when you need to permanently remove a context from your CircleCI organization. This action is irreversible and will delete all environment variables associated with the context.

• Delete Context Restriction

  Tool to delete a context restriction by its ID. Use when you need to remove a specific restriction from a CircleCI context.

• Delete Namespace Alias

  Tool to remove a namespace alias by name in CircleCI. Use when you need to delete an existing namespace alias that is no longer needed. The mutation returns a boolean indicating success and any errors that occurred during deletion.

• Delete Namespace and Related Orbs

  Tool to delete a CircleCI registry namespace and all its associated orbs. Use when you need to permanently remove a namespace from the registry. This is a destructive operation that cannot be undone.

• Delete Organization Group

  Tool to delete a group from a CircleCI organization. Use when you need to remove a group permanently from the organization.

• Delete Organization Orb Allowlist Entry

  Tool to remove an entry from the organization's URL orb allow-list. Use when you need to revoke access to a previously allowed orb URL.

• Delete Project

  Tool to delete a CircleCI project and its settings. Use when you need to permanently remove a project from CircleCI. This action cannot be undone.

• Get Job Artifacts

  Retrieves artifacts (output files like test results, logs, build binaries, reports) produced by a CircleCI job. Use this when you need to access files generated during a job's execution, such as test reports, coverage data, compiled binaries, or deployment artifacts. Returns download URLs for each artifact. Note: Jobs may produce zero artifacts if none were explicitly stored using 'store_artifacts' in the config.

• Get Job Details

  Tool to fetch details of a specific job within a project. Use when you need status, timing, and executor information for a CircleCI job by its number.

• Get Orb Version

  Tool to retrieve detailed information about a specific CircleCI orb version via GraphQL. Use when you need orb source code, version history, usage statistics, or metadata for a specific orb version.

• Get Organization Group

  Tool to retrieve a group in an organization. Use when you need to get details about a specific group within a CircleCI organization.

• Get Pipeline Config

  Tool to fetch pipeline configuration by ID. Use when you need the source or compiled YAML of a specific pipeline.

• Get Pipeline Definition

  Tool to retrieve a pipeline definition by project and definition ID. Use when you need details about a specific pipeline definition's configuration, sources, and metadata.

• Get Test Metadata

  Tool to fetch test metadata for a specific job. Use when you need detailed test results, run times, and failure messages after a job completes.

• Get Usage Export Job

  Tool to retrieve a usage export job by organization ID and job ID. Use when you need to check the status or download URLs of a usage export job.

• Get User Information

  Tool to retrieve information about a CircleCI user by their unique ID. Use when you need user profile details after obtaining the user ID.

• List Namespace Orbs

  Tool to list orbs in a CircleCI registry namespace with pagination support. Use when you need to browse available orbs in a namespace, filter by visibility (public/private), or retrieve orb statistics. Returns up to 20 orbs per page with cursor-based pagination.

• List Orb Categories

  Tool to retrieve all CircleCI orb categories with pagination support. Use when you need to list available categories for orb classification. Returns up to 20 categories per page with cursor-based pagination.

• List Pipelines for Project

  Tool to list all pipelines for a specific project. Use when you need to retrieve the pipelines for a project (e.g., to display recent runs on a dashboard).

• List Self-Hosted Runners

  List self-hosted runners in CircleCI. Use this to retrieve information about your organization's self-hosted runners, optionally filtered by namespace or resource class. Useful for monitoring runner availability and status.

• List Workflows by Pipeline ID

  Tool to list all workflows associated with a specific pipeline. Use when you need to fetch or paginate through workflows by pipeline ID.

• Query Namespace Exists

  Tool to determine if a namespace exists in the CircleCI registry. Use when you need to verify namespace existence before performing operations. Returns a boolean indicating whether the namespace exists.

• Query Orb Category ID

  Tool to fetch the unique category ID for a CircleCI orb category by its name. Use when you need to categorize orbs or query category-specific information. Returns null in the data field if the category name does not exist.

• Query Orb Exists

  Tool to check if an orb exists in CircleCI registry and retrieve its privacy status. Use when you need to verify orb existence or check if an orb is private/public. Returns null in the data.orb field if the orb does not exist.

• Query Orb ID

  Tool to fetch an orb's ID and optionally its namespace ID by orb name. Use when you need to query orb identifiers for CircleCI orbs. The name parameter should be the full orb reference (namespace/orbname). Optionally provide the namespace parameter to also retrieve the namespace ID in the same call.

• Query Orb Latest Version

  Tool to fetch the latest published version of a CircleCI orb. Use when you need to check the most recent version number of an orb for dependency management or updates. Returns null in the data field if the orb does not exist.

• Query Orb Source

  Tool to retrieve source code of a specific CircleCI orb version via GraphQL. Use when you need to access the YAML configuration or inspect the implementation of an orb version. Returns null if the orb version reference does not exist.

• Remove Context Environment Variable (GraphQL)

  Tool to remove an environment variable from a CircleCI context using GraphQL API. Use when you need to delete a context-level environment variable by its name.

• Rename Namespace

  Tool to rename a CircleCI namespace by its UUID identifier. Use when you need to change the name of an existing namespace. Returns the renamed namespace ID on success, or errors if the operation fails.

• Store Environment Variable

  Tool to store an environment variable in a CircleCI context using GraphQL mutation. Use when you need to add or update an environment variable within a specific context.

• Trigger Pipeline

  Triggers a new CI/CD pipeline run for a specified CircleCI project. Use this tool to programmatically start a build on a specific branch or tag, optionally passing custom pipeline parameters for conditional workflow execution. Requires write access to the project.

• Validate Orb Config

  Tool to validate CircleCI orb YAML configuration using the orbConfig GraphQL query. Use when you need to verify that an orb definition is syntactically correct before publishing or using it. Returns validation status, any errors found, and the processed YAML output.