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

# Get connection status

> Return connection status.

`veryfront__get_connection_status`

Requires project.integrations.read.

## Access

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

**Call type:** Read-only.

## 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 to inspect. Requires viewer access to the project. API keys never see user-scope connections. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused. Values: `"user"`, `"project"`. |

## 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__get_connection_status",
    "arguments": {
      "name": "example",
      "scope": "user"
    }
  }
}
```

## 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 |
| - | - | - | - |
| `integration` | `string` | Yes | Integration name that was checked. |
| `scope` | `string` | Yes | Connection owner: user for your own connection in the project, project for the shared one. Values: `"user"`, `"project"`. |
| `connected` | `boolean` | Yes | True when a usable connection exists for this owner. |
| `connection_id` | `string or null` | Yes | ID of the current connection; null when connected is false. Pass it to [`delete_connection`](/docs/cloud/mcp/tools/delete-connection). |
| `connection_generation_id` | `string or null` | Yes | Generation of the current connection; null when connected is false. |

## 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 to inspect. Requires viewer access to the project. API keys never see user-scope connections. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused."
    }
  },
  "required": [
    "name",
    "scope"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_connection_status tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "integration": {
      "type": "string",
      "description": "Integration name that was checked."
    },
    "scope": {
      "type": "string",
      "enum": [
        "user",
        "project"
      ],
      "description": "Connection owner: user for your own connection in the project, project for the shared one."
    },
    "connected": {
      "type": "boolean",
      "description": "True when a usable connection exists for this owner."
    },
    "connection_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null",
          "description": "The connection id returned by the tool."
        }
      ],
      "description": "ID of the current connection; null when connected is false. Pass it to delete_connection."
    },
    "connection_generation_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null",
          "description": "The connection generation id returned by the tool."
        }
      ],
      "description": "Generation of the current connection; null when connected is false."
    }
  },
  "required": [
    "integration",
    "scope",
    "connected",
    "connection_id",
    "connection_generation_id"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_connection_status 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__get_connection_status` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


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