Get 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

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found. Minimum length: 1.
namestringYesIntegration name, for example github or slack. Minimum length: 1.
scopestringYesConnection 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.

json
{
  "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.

FieldTypeRequiredDescription and constraints
integrationstringYesIntegration name that was checked.
scopestringYesConnection owner: user for your own connection in the project, project for the shared one. Values: "user", "project".
connectedbooleanYesTrue when a usable connection exists for this owner.
connection_idstring or nullYesID of the current connection; null when connected is false. Pass it to delete_connection.
connection_generation_idstring or nullYesGeneration of the current connection; null when connected is false.

Full schemas

json
{
  "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
{
  "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#"
}