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

# Create connect session

> Create connect session.

`veryfront__create_connect_session`

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Can change resources.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `project_reference` | `string` | No | Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns `not_found`. Minimum length: `1`. |
| `name` | `string` | Yes | Integration name, for example github or slack. Minimum length: `1`. |
| `scope` | `string` | Yes | Connection owner. Project scope needs the editor role; user scope connects your own account and needs viewer access to the project. API keys also need the integrations write scope. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused. Values: `"user"`, `"project"`. |
| `redirect_uri` | `string` | Yes | Trusted web or native URI the browser returns to after consent. Maximum length: `4096`. |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_connect_session",
    "arguments": {
      "name": "github",
      "scope": "user",
      "redirect_uri": "veryfront://auth/integrations"
    }
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `session_token` | `string` | Yes | One-time connect session token, embedded in `connect_url`. |
| `connect_url` | `string` | Yes | URL to open in a browser. It starts provider consent through GET /oauth/connect/\{integration}. |
| `expires_at` | `string` | Yes | UTC time (RFC 3339) after which `connect_url` no longer starts consent. Format: `date-time`. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Integration name, for example github or slack."
    },
    "scope": {
      "type": "string",
      "enum": [
        "user",
        "project"
      ],
      "description": "Connection owner. Project scope needs the editor role; user scope connects your own account and needs viewer access to the project. API keys also need the integrations write scope. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused."
    },
    "redirect_uri": {
      "type": "string",
      "maxLength": 4096,
      "description": "Trusted web or native URI the browser returns to after consent."
    }
  },
  "required": [
    "name",
    "scope",
    "redirect_uri"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_connect_session tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "session_token": {
      "type": "string",
      "description": "One-time connect session token, embedded in connect_url."
    },
    "connect_url": {
      "type": "string",
      "description": "URL to open in a browser. It starts provider consent through GET /oauth/connect/{integration}."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "UTC time (RFC 3339) after which connect_url no longer starts consent."
    }
  },
  "required": [
    "session_token",
    "connect_url",
    "expires_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_connect_session tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__create_connect_session` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run this tool with these arguments.

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.