> ## 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.

# Getting Started with StackOne

> Configure your first connector and connect it to your agent in 5 minutes

<img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/getting-started-steps.svg?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=2952df11461a210e35e82e1d596e3e7a" alt="Getting started steps: Configure Connector, Link Account, Connect Agent" style={{width: '100%', maxWidth: '800px', margin: '0 auto 24px', display: 'block'}} width="900" height="220" data-path="images/getting-started-steps.svg" />

<Note>
  On first login, you'll be prompted to create an organization and project. Once that's done, continue below to start using a connector.
</Note>

## Configure Connector and Link an Account

<Steps>
  <Step title="Create a Connector Profile">
    Before linking an account, you need to enable and configure a <a href="/guides/connector-profiles" target="_blank">**Connector Profile**</a>. This is used to set up authentication and the actions and/or events you are looking to use.

    1. In the [StackOne dashboard](https://app.stackone.com/) sidebar, open **Connectors**
    2. Search for a connector you are interested in using (e.g. Zendesk, Gmail, Salesforce) and select it. This will open the **Connector page**.
    3. Following the **Quick Setup**, click **Add Profile**. This will open a side panel to configure the profile.

    <Frame caption="Connector page: Quick Setup with the Add Profile button">
      <img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/guides/getting-started/add-profile.png?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=9e9c2a625fcde6d4cb1946bda1b16574" alt="Connector page showing the Quick Setup section with an Add Profile button" width="2416" height="1486" data-path="images/guides/getting-started/add-profile.png" />
    </Frame>
  </Step>

  <Step title="Configure the Connector Profile">
    1. Leave the **Version** at **Latest**.
    2. Leave the **Profile name** as the default value.
    3. If multiple options exist, choose the **Authentication type** you wish to use.

    <Note>
      Depending on the Connector, there may be additional fields to complete (e.g. Client ID, Client Secret, API Key etc.) and/or additional configuration on the provider system. Check the [Connector Guides](/connectors) and follow the relevant Connector Profile guide.
    </Note>

    4. For getting started, we recommend deselecting all **Actions** and manually selecting a few read actions to test.
    5. Click **Create Profile**. The Connector Profile is now ready to use.

    <Frame caption="Connector Profile side panel: Version, Profile name, and Authentication type">
      <img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/guides/getting-started/connector-profile.png?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=e1455e121e09ff5d246978d891b2267e" alt="Connector Profile configuration side panel showing version, profile name, and authentication type" width="2294" height="1812" data-path="images/guides/getting-started/connector-profile.png" />
    </Frame>

    <Frame caption="Actions selection: deselect all, then enable a few read actions to test">
      <img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/guides/getting-started/connector-profile-actions.png?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=738b2c5ea7e6d1ac74f8df530b0dbe17" alt="Action selection panel within the Connector Profile, showing per-action toggles" width="2292" height="1340" data-path="images/guides/getting-started/connector-profile-actions.png" />
    </Frame>
  </Step>

  <Step title="Link an Account">
    There are <a href="/guides/connect-tools-overview" target="_blank">multiple methods for linking an account</a>. In this guide, we'll link one directly through the StackOne dashboard.

    1. Following the **Quick Setup**, click the now enabled **Link Account** button. This will open the **Link an Account** popup.
    2. Select **Method 2 - Authenticate Now**.

    <Frame caption="Link an Account popup: Method 2 - Authenticate Now">
      <img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/guides/getting-started/link-account.png?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=8237f03bf446c4b75d6d5960b029a48b" alt="Link an Account popup showing the three connection methods with Method 2 - Authenticate Now selected" width="1840" height="1390" data-path="images/guides/getting-started/link-account.png" />
    </Frame>

    3. On **Enter Origin Owner Details**, leave all as default values and click **Next**.
    4. On **Integration Hub Preferences**, confirm the Connector Profile you configured earlier is selected, then click **Next**.

    <Note>
      Depending on the Connector there may be additional fields to complete and/or additional configuration on the provider system. Click **Connection Guide** in the top right for more details if needed.
    </Note>

    5. Click **Connect**.
    6. You may need to complete authentication with the provider (e.g. via OAuth). In this case a new window will pop up prompting you to sign in as needed.

    Once authorization is complete, your **Account** will now be linked in StackOne.
  </Step>
</Steps>

## Use the Connector

With a linked account in place, you can now use this Connector in the Agent of your choice. We recommend connecting it to your preferred agent client via **MCP**. You can also call StackOne directly from a TypeScript or Python agent, or an A2A orchestrator. If you just want to sanity-check the connector first, the **Playground** lets you test it without wiring up an agent.

<Tabs>
  <Tab title="MCP">
    The dashboard generates a ready-to-use MCP server for your linked account.

    <Steps>
      <Step>
        Following the **Quick Setup**, click the now enabled **Use in Agent** button. This will open the **Use with Agent Client** side panel.
      </Step>

      <Step>
        Under **MCP Server** > **Select Account**, choose the account you configured above.
      </Step>

      <Step>
        (Optional) Set the MCP Server Expiry. Default is 1 year.
      </Step>

      <Step>
        Select the agent client you want to be able to use this Connector.

        <Note>
          Further instructions are provided for most major platforms, otherwise the **HTTPS MCP** option reveals the URL that can be used in other MCP-compatible clients that support Streamable HTTP.
        </Note>
      </Step>

      <Step>
        Once the agent client confirms the connection, try a prompt like `"What tools can I use?"` or `"List the latest 5 records"` to verify the Connector is working.
      </Step>
    </Steps>

    <Frame caption="Use with Agent Client side panel: select account, set expiry, choose your client">
      <img src="https://mintcdn.com/stackone-60/1XjJKQgTbXHChcoq/images/guides/getting-started/use-connector.png?fit=max&auto=format&n=1XjJKQgTbXHChcoq&q=85&s=7eed2c8be0e63ed9fdcc93852898b66d" alt="Use with Agent Client side panel showing MCP Server account selector, expiry, and agent client options" width="2290" height="1886" data-path="images/guides/getting-started/use-connector.png" />
    </Frame>

    <Card title="MCP Quickstart →" icon="bolt" href="/mcp/quickstart">
      Client-specific setup for Claude, Cursor, n8n, Vercel AI, and more
    </Card>
  </Tab>

  <Tab title="TypeScript SDK">
    For OpenAI Agents SDK, Vercel AI SDK, or a custom TypeScript agent.

    <Steps>
      <Step title="Create a StackOne API key">
        In the dashboard sidebar, open **Project Settings → API Keys**, click **Create API Key**, give it a name (e.g. `local-dev`), and copy the key — it's only shown once.

        <Note>
          The <a href="/guides/api-keys" target="_blank">StackOne API key</a> authenticates your application against StackOne and is separate from any provider credentials in the <a href="/guides/connector-profiles" target="_blank">Connector Profile</a>.
        </Note>
      </Step>

      <Step title="Follow your framework's integration guide">
        <CardGroup cols={2}>
          <Card title="OpenAI Agents SDK" icon="robot" href="/agents/typescript/frameworks/openai-integration" />

          <Card title="Vercel AI SDK" icon="bolt" href="/agents/typescript/frameworks/vercel-ai-sdk" />
        </CardGroup>

        Or start with [Installation](/agents/typescript/installation) and [Basic Usage](/agents/typescript/basic-usage) for a custom setup.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Python SDK">
    For LangChain, LangGraph, CrewAI, OpenAI Agents SDK, Pydantic AI, or a custom Python agent.

    <Steps>
      <Step title="Create a StackOne API key">
        In the dashboard sidebar, open **Project Settings → API Keys**, click **Create API Key**, give it a name (e.g. `local-dev`), and copy the key — it's only shown once.

        <Note>
          The <a href="/guides/api-keys" target="_blank">StackOne API key</a> authenticates your application against StackOne and is separate from any provider credentials in the <a href="/guides/connector-profiles" target="_blank">Connector Profile</a>.
        </Note>
      </Step>

      <Step title="Follow your framework's integration guide">
        <CardGroup cols={2}>
          <Card title="LangChain" icon="link" href="/agents/python/frameworks/langchain-integration" />

          <Card title="LangGraph" icon="diagram-project" href="/agents/python/frameworks/langgraph-integration" />

          <Card title="CrewAI" icon="users" href="/agents/python/frameworks/crewai-integration" />

          <Card title="OpenAI Agents SDK" icon="robot" href="/agents/python/frameworks/openai-integration" />

          <Card title="Pydantic AI" icon="square-check" href="/agents/python/frameworks/pydantic-ai-integration" />
        </CardGroup>

        Or start with [Installation](/agents/python/installation) and [Basic Usage](/agents/python/basic-usage) for a custom setup.
      </Step>
    </Steps>
  </Tab>

  <Tab title="A2A">
    For Google ADK, AG2, BeeAI, or any other A2A-aware orchestrator over the <a href="/a2a/introduction" target="_blank">Agent-to-Agent protocol</a>.

    <Steps>
      <Step title="Create a StackOne API key">
        In the dashboard sidebar, open **Project Settings → API Keys**, click **Create API Key**, give it a name (e.g. `local-dev`), and copy the key — it's only shown once.

        <Note>
          The <a href="/guides/api-keys" target="_blank">StackOne API key</a> authenticates your application against StackOne and is separate from any provider credentials in the <a href="/guides/connector-profiles" target="_blank">Connector Profile</a>.
        </Note>
      </Step>

      <Step title="Follow your framework's integration guide">
        <CardGroup cols={2}>
          <Card title="Google ADK" icon="google" href="/a2a/framework-guides/adk" />

          <Card title="AG2" icon="users" href="/a2a/framework-guides/ag2" />

          <Card title="BeeAI" icon="bee" href="/a2a/framework-guides/beeai" />

          <Card title="A2A SDK" icon="code" href="/a2a/a2a-sdk" />
        </CardGroup>

        Or see the [A2A Quickstart](/a2a/quickstart) for the agent card URL, message format, and headers.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Playground">
    The [AI Playground](/guides/playground) lets you test actions with natural language directly in the dashboard without having your own agent client.

    <Steps>
      <Step>
        In the dashboard sidebar, open **Playground**.
      </Step>

      <Step>
        1. In the **Configure** panel, click **Manage Action Sources**.
        2. Select the Account you previously linked.
        3. Click **Done**.
      </Step>

      <Step>
        Try a prompt like `"What tools can I use?"` or `"List the latest 5 records"`.
      </Step>
    </Steps>

    You should be able to see the tool calls and responses from the agent, and provide follow-up prompts.

    <Card title="Full Playground Guide →" icon="wand-magic-sparkles" href="/guides/playground">
      Available models, debugging tool calls, and Playground limits
    </Card>
  </Tab>
</Tabs>

<Card title="Compare Agent Protocols →" icon="scale-balanced" href="/guides/calling-stackone-actions">
  Side-by-side comparison of MCP, SDKs, and A2A with worked examples.
</Card>

***

## What's Next?

<CardGroup cols={2}>
  <Card title="StackOne 101" icon="book" href="/">
    Understand projects, connectors, actions, and accounts
  </Card>

  <Card title="Linking Accounts" icon="window" href="/guides/connect-tools-overview">
    Let end-users connect their accounts
  </Card>

  <Card title="Manage Accounts" icon="users" href="/guides/accounts-section">
    Monitor linked accounts and connection health
  </Card>

  <Card title="Browse Connectors" icon="grid" href="/connectors/introduction">
    See all 200+ supported providers
  </Card>
</CardGroup>
