---
title: "Introduction"
description: "A universal TypeScript SDK for seamlessly connecting your applications to third-party integrations"
---

<Callout type="info">
**For AI agents:** Start with the Markdown entry point at [`/llms.txt`](/llms.txt). Individual pages are also available as `.mdx` exports (for example, [`/docs/getting-started/basic-usage.mdx`](/docs/getting-started/basic-usage.mdx)).
</Callout>

The Integrate SDK is a universal, type-safe TypeScript library that bridges your applications to third-party services through the Model Context Protocol (MCP). It provides seamless integration with services like GitHub, Gmail, Notion, and more, both in the browser and on the server, without the complexity of managing OAuth flows, API differences, or connection states.

## Why Integrate SDK?

Building applications that connect to multiple third-party services is challenging. Each service has its own OAuth implementation, API quirks, and authentication patterns. You need to handle OAuth flows in the browser, manage tokens securely, make API calls from your backend, and deal with re-authentication when tokens expire.

The Integrate SDK solves this by providing a unified, type-safe interface to all your integrations. You configure your OAuth credentials once, authorize users through a seamless flow (popup or redirect), and then make API calls from anywhere in your stack, whether that's client-side JavaScript, server-side API routes, or serverless functions. The SDK handles token management, streaming connections to the MCP server, and provides full TypeScript support so you know exactly what tools are available and what parameters they need.

## How It Works

The SDK connects to the Integrate MCP server (`https://mcp.integrate.dev/api/v1/mcp`) using HTTP streaming with newline-delimited JSON. You bring your own OAuth app credentials for each integration you want to use, whether that's a GitHub OAuth app, Google Cloud project, or Notion integration.

When a user authorizes your app, the OAuth flow happens through the server, which securely stores the credentials. The SDK receives a session token that it uses for all subsequent API calls. This token works everywhere: in the browser for rich user experiences, in your Next.js API routes for server-side operations, or in your Node.js backend services.

**Important:** You control your own OAuth applications and credentials. The SDK acts as a secure bridge, sending your OAuth configuration to the Integrate server which handles the complex authentication flows and API calls on your behalf.

## Features

The Integrate SDK is designed to be both powerful and simple to use:

- 🔌 **Integration-Based Architecture** - Enable only the integrations you need, reducing bundle size and surface area
- 🔒 **Type-Safe** - Full TypeScript support with IntelliSense for every tool, parameter, and response
- 🌊 **Real-time Communication** - HTTP streaming with NDJSON for efficient, real-time data flow
- 🔐 **Complete OAuth Flow** - Built-in OAuth 2.0 with PKCE support in both popup and redirect modes
- ⏰ **Scheduled Triggers** - Schedule tool executions for specific times or recurring intervals with cron expressions
- 🌍 **Universal** - Works seamlessly in browsers, Node.js, Edge runtimes, and serverless environments
- 🛠️ **Extensible** - Add any integration supported by the Integrate MCP server with simple integration configuration
- 📦 **Zero Dependencies** - Lightweight implementation with no external dependencies
- 🔄 **Automatic Re-authentication** - Handle token expiration gracefully with built-in re-auth flows
- 🎯 **Tool Discovery** - Automatically discover available tools based on your enabled integrations

## Get Started

<Cards>
  <Card
    title="Installation"
    href="/docs/getting-started/installation"
    description="Install the SDK in your project"
  />
  <Card
    title="Quick Start"
    href="/docs/getting-started/basic-usage"
    description="Get up and running in minutes"
  />
  <Card
    title="Triggers"
    href="/docs/getting-started/triggers"
    description="Schedule tool executions with one-time or recurring triggers"
  />
  <Card
    title="OAuth Flow"
    href="/docs/getting-started/basic-usage"
    description="Learn how to authorize users with OAuth 2.0"
  />
  <Card
    title="Built-in Integrations"
    href="/docs/integrations"
    description="Explore GitHub, Gmail, and other integrations"
  />
  <Card
    title="Advanced Usage"
    href="/docs/getting-started/advanced-usage"
    description="Error handling, re-auth, and more"
  />
  <Card
    title="Vercel AI SDK"
    href="/docs/artificial-intelligence/vercel-ai-sdk"
    description="Integrate with Vercel AI SDK"
  />
  <Card
    title="Examples"
    href="https://github.com/integratedotdev/examples"
    description="Runnable framework, database, and AI SDK projects"
  />
</Cards>

## The Journey of an Integration

Here's what happens when you integrate a third-party service into your application:

### 1. **Configuration**

You configure the SDK with integrations for each service you want to use: GitHub for repository management, Gmail for email, Notion for knowledge base access, and so on. Each integration knows what OAuth credentials it needs and what tools it provides.

### 2. **Authorization**

When a user needs to connect their account, the SDK orchestrates the OAuth 2.0 flow. In the browser, this happens seamlessly through a popup or redirect. The user authorizes your app with the third-party service, and the Integrate server securely stores their credentials.

### 3. **Connection**

The SDK establishes a streaming connection to `https://mcp.integrate.dev/api/v1/mcp` and receives a session token. This token is your golden ticket: it represents the user's authorized connections and works anywhere in your application.

### 4. **Discovery**

The SDK queries the server for available tools and intelligently filters them based on your enabled integrations. With full TypeScript support, your IDE immediately knows what tools are available, what parameters they accept, and what they return.

### 5. **Execution**

When you call a tool (for example, creating a GitHub issue or sending an email), the SDK sends a JSON-RPC request over the streaming connection. The server executes the action using the stored OAuth credentials and streams the response back to your application.

### 6. **Persistence**

Session tokens can be persisted across page reloads and shared between client and server. Once a user has authorized your app in the browser, your backend services can use the same token to make API calls on their behalf.

## Universal by Design

The SDK adapts to its environment, providing the right capabilities for each context:

### 🌐 Browser Environments

In the browser, the SDK provides the complete user experience. Users can authorize their accounts through intuitive popup or redirect flows. The SDK manages session tokens, makes API calls, and handles re-authentication when needed. It's perfect for building rich, interactive experiences where users directly interact with their connected services.

### 🖥️ Server Environments

On the server, whether that's Node.js, Edge runtimes, or serverless functions, the SDK focuses on execution. Given a valid session token (typically obtained from browser authorization and passed via cookies or headers), it makes API calls efficiently without any UI concerns. This is ideal for backend operations, scheduled jobs, or API routes that need to interact with third-party services on behalf of users.

### 🔄 The Typical Pattern

Most applications follow this pattern: handle OAuth authorization in the browser where users can interact with the authorization UI, then share the session token with your backend through secure HTTP-only cookies or authorization headers. Your server-side code can then make API calls using the same session token, maintaining a seamless experience across your entire stack.

## Technical Details

The SDK communicates with the Integrate MCP server using the Model Context Protocol:

- **Endpoint:** `https://mcp.integrate.dev/api/v1/mcp`
- **Protocol:** MCP over HTTP streaming for real-time, efficient communication
- **Format:** Newline-delimited JSON (NDJSON) for progressive responses
- **Methods:** `initialize`, `tools/list`, `tools/call` for complete integration lifecycle
- **Security:** OAuth 2.0 with PKCE for secure authorization flows