> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connector YAML Reference

> Create custom connectors and make them available in your StackOne projects

StackOne connectors are defined in YAML. The same schema powers every pre-built connector, and you can use it to build your own.

<Info>
  This workflow is optimized for **[Claude Code](https://claude.com/claude-code)**, which excels at tool calling and long-horizon tasks required for connector development. The MCP server and tools also work with other AI coding agents like Cursor, VS Code with Claude, and opencode.
</Info>

<Note>
  Custom connectors require enterprise access. Contact [support@stackone.com](mailto:support@stackone.com) for access.
</Note>

***

## Prerequisites

* StackOne Agent Credentials (Contact [support@stackone.com](mailto:support@stackone.com) to request your agent credentials)
* StackOne CLI (`@stackone/cli`)
* API key with **Connectors** scopes enabled (see [API Keys](/embed/api-keys#scopes))
  * `connectors:read`: required to download connectors from the registry
  * `connectors:write`: required to push and delete connectors
  * `credentials:read`: required so the `run` command can use the credentials of the specified linked account

***

## Key Capabilities

| Feature               | Description                                                            |
| --------------------- | ---------------------------------------------------------------------- |
| **Step Functions**    | `request`, `paginated_request`, `map_fields`, `typecast`, `group_data` |
| **Authentication**    | OAuth2, API Key, Basic Auth, Custom headers                            |
| **Expressions**       | JSONPath, String interpolation, JEXL templates                         |
| **Pagination**        | Cursor, offset, and page-based pagination                              |
| **Conditional Logic** | Include arguments only when conditions are met                         |
| **Rate Limiting**     | Built-in request throttling                                            |

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Build Your First Connector" icon="rocket" href="/connector-building/first-connector">
    Step-by-step guide from setup to deployment
  </Card>

  <Card title="YAML Schema" icon="book" href="/connector-yaml-reference/yaml-schema">
    Every field in the connector definition
  </Card>

  <Card title="Build Workflow" icon="robot" href="/connector-building/build-workflow">
    AI-powered connector generation
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/connector-building/stackone-cli">
    All CLI commands
  </Card>
</CardGroup>