> ## 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 project integration

> Read the settings of a project for one integration to show or check its scope, allowed tools, configuration, execution mode and connection counts; returns the project integration, with configured false and the defaults when no settings are stored.

`veryfront__get_project_integration`

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. Minimum length: `1`. |
| `name` | `string` | Yes | Integration name, for example "salesforce". Minimum length: `1`. Maximum length: `128`. |

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

## 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 |
| - | - | - | - |
| `configured` | `boolean` | Yes | |
| `created_at` | `string or null` | Yes | Creation timestamp in ISO 8601 format. |
| `updated_at` | `string or null` | Yes | Last update timestamp in ISO 8601 format. |
| `name` | `string` | Yes | Human-readable name for the returned record. |
| `display_name` | `string` | Yes | |
| `icon` | `string` | Yes | |
| `description` | `string` | Yes | Human-readable description returned by the tool. |
| `auth_type` | `string` | Yes | Values: `"oauth2"`, `"oauth1"`, `"api-key"`, `"basic"`. |
| `tool_count` | `integer` | Yes | Minimum: `0`. |
| `prompt_count` | `integer` | Yes | Minimum: `0`. |
| `connected_for_project` | `boolean` | Yes | |
| `scope` | `string` | Yes | Values: `"project"`, `"user"`. |
| `allowed_tools` | `string[] or null` | Yes | |
| `config` | `object` | Yes | Structured config details associated with this tool result. |
| `execution_mode` | `string` | Yes | Values: `"real"`, `"mock"`. |
| `config_schema` | `object or null` | Yes | The project configuration schema of the integration that config must match, or null when it declares none. |
| `project_connections` | `object` | Yes | Structured project connections details associated with this tool result. |
| `project_user_connections` | `object` | Yes | Private connections belonging to the interactive viewer in this project. Zero for API keys and service credentials. |
| `resolution` | `object` | Yes | Structured resolution details associated with this tool result. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Integration name, for example \"salesforce\"."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_project_integration tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "configured": {
      "type": "boolean"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "description": "Creation timestamp in ISO 8601 format."
        },
        {
          "type": "null",
          "description": "Creation timestamp in ISO 8601 format."
        }
      ],
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "description": "Last update timestamp in ISO 8601 format."
        },
        {
          "type": "null",
          "description": "Last update timestamp in ISO 8601 format."
        }
      ],
      "description": "Last update timestamp in ISO 8601 format."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "display_name": {
      "type": "string"
    },
    "icon": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description returned by the tool."
    },
    "auth_type": {
      "type": "string",
      "enum": [
        "oauth2",
        "oauth1",
        "api-key",
        "basic"
      ]
    },
    "tool_count": {
      "type": "integer",
      "minimum": 0
    },
    "prompt_count": {
      "type": "integer",
      "minimum": 0
    },
    "connected_for_project": {
      "type": "boolean"
    },
    "scope": {
      "type": "string",
      "enum": [
        "project",
        "user"
      ]
    },
    "allowed_tools": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of allowed tools associated with this tool result."
        },
        {
          "type": "null",
          "description": "The allowed tools returned by the tool."
        }
      ]
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      },
      "description": "Structured config details associated with this tool result."
    },
    "execution_mode": {
      "type": "string",
      "enum": [
        "real",
        "mock"
      ]
    },
    "config_schema": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "version": {
              "type": "number",
              "const": 1
            },
            "fields": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "const": "select"
                      },
                      "label": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string",
                        "description": "Human-readable description returned by the tool."
                      },
                      "default": {
                        "type": "string"
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "value": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string",
                              "description": "Human-readable description returned by the tool."
                            }
                          },
                          "required": [
                            "value",
                            "label"
                          ],
                          "additionalProperties": false
                        },
                        "description": "List of options associated with this tool result."
                      }
                    },
                    "required": [
                      "key",
                      "type",
                      "label",
                      "options"
                    ],
                    "additionalProperties": false,
                    "description": "Structured option 1 details associated with this tool result."
                  },
                  {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "const": "multiselect"
                      },
                      "label": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string",
                        "description": "Human-readable description returned by the tool."
                      },
                      "default": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "value": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string",
                              "description": "Human-readable description returned by the tool."
                            }
                          },
                          "required": [
                            "value",
                            "label"
                          ],
                          "additionalProperties": false
                        },
                        "description": "List of options associated with this tool result."
                      }
                    },
                    "required": [
                      "key",
                      "type",
                      "label",
                      "options"
                    ],
                    "additionalProperties": false,
                    "description": "Structured option 2 details associated with this tool result."
                  },
                  {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "const": "boolean"
                      },
                      "label": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string",
                        "description": "Human-readable description returned by the tool."
                      },
                      "default": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "key",
                      "type",
                      "label"
                    ],
                    "additionalProperties": false,
                    "description": "Structured option 3 details associated with this tool result."
                  },
                  {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "const": "number"
                      },
                      "label": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string",
                        "description": "Human-readable description returned by the tool."
                      },
                      "default": {
                        "type": "number"
                      },
                      "min": {
                        "type": "number"
                      },
                      "max": {
                        "type": "number"
                      },
                      "step": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "key",
                      "type",
                      "label"
                    ],
                    "additionalProperties": false,
                    "description": "Structured option 4 details associated with this tool result."
                  }
                ]
              },
              "description": "Fields returned for the structured input request."
            }
          },
          "required": [
            "version",
            "fields"
          ],
          "additionalProperties": false,
          "description": "Structured config schema details associated with this tool result."
        },
        {
          "type": "null",
          "description": "The config schema returned by the tool."
        }
      ],
      "description": "The project configuration schema of the integration that config must match, or null when it declares none."
    },
    "project_connections": {
      "type": "object",
      "properties": {
        "connected": {
          "type": "integer",
          "minimum": 0
        },
        "expired": {
          "type": "integer",
          "minimum": 0
        },
        "disconnected": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "connected",
        "expired",
        "disconnected"
      ],
      "additionalProperties": false,
      "description": "Structured project connections details associated with this tool result."
    },
    "project_user_connections": {
      "type": "object",
      "properties": {
        "connected": {
          "$ref": "#/properties/project_connections/properties/connected",
          "description": "The connected returned by the tool."
        },
        "expired": {
          "$ref": "#/properties/project_connections/properties/expired",
          "description": "The expired returned by the tool."
        },
        "disconnected": {
          "$ref": "#/properties/project_connections/properties/disconnected",
          "description": "The disconnected returned by the tool."
        }
      },
      "required": [
        "connected",
        "expired",
        "disconnected"
      ],
      "additionalProperties": false,
      "description": "Private connections belonging to the interactive viewer in this project. Zero for API keys and service credentials."
    },
    "resolution": {
      "type": "object",
      "properties": {
        "catalog_available": {
          "type": "boolean"
        },
        "catalog_state": {
          "type": "string",
          "enum": [
            "available",
            "removed"
          ]
        },
        "policy": {
          "type": "object",
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "absent",
                "allowed",
                "restricted"
              ]
            },
            "scope": {
              "type": "string",
              "enum": [
                "project",
                "user"
              ]
            },
            "allowed_tools": {
              "anyOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "List of allowed tools associated with this tool result."
                },
                {
                  "type": "null",
                  "description": "The allowed tools returned by the tool."
                }
              ]
            },
            "execution_mode": {
              "$ref": "#/properties/execution_mode",
              "description": "The execution mode returned by the tool."
            }
          },
          "required": [
            "state",
            "scope",
            "allowed_tools",
            "execution_mode"
          ],
          "additionalProperties": false,
          "description": "Structured policy details associated with this tool result."
        },
        "credential_requirement": {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "oauth_connection",
                "project_credentials",
                "none"
              ]
            },
            "managed_oauth": {
              "type": "boolean"
            },
            "byo_oauth_app_override": {
              "type": "object",
              "properties": {
                "supported": {
                  "type": "boolean"
                },
                "required": {
                  "type": "boolean"
                },
                "client_id_env_var": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "client_secret_env_var": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "supported",
                "required",
                "client_id_env_var",
                "client_secret_env_var"
              ],
              "additionalProperties": false,
              "description": "Structured byo oauth app override details associated with this tool result."
            },
            "mandatory_env_vars": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of mandatory env vars associated with this tool result."
            }
          },
          "required": [
            "mode",
            "managed_oauth",
            "byo_oauth_app_override",
            "mandatory_env_vars"
          ],
          "additionalProperties": false,
          "description": "Structured credential requirement details associated with this tool result."
        },
        "connection_readiness": {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "ready",
                "required",
                "not_applicable",
                "unknown"
              ],
              "description": "Lifecycle status for the returned record."
            },
            "scope": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "project",
                    "user"
                  ]
                },
                {
                  "type": "null",
                  "description": "The scope returned by the tool."
                }
              ]
            },
            "connected_count": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0
                },
                {
                  "type": "null",
                  "description": "The connected count returned by the tool."
                }
              ]
            }
          },
          "required": [
            "status",
            "scope",
            "connected_count"
          ],
          "additionalProperties": false,
          "description": "Structured connection readiness details associated with this tool result."
        }
      },
      "required": [
        "catalog_available",
        "catalog_state",
        "policy",
        "credential_requirement",
        "connection_readiness"
      ],
      "additionalProperties": false,
      "description": "Structured resolution details associated with this tool result."
    }
  },
  "required": [
    "configured",
    "created_at",
    "updated_at",
    "name",
    "display_name",
    "icon",
    "description",
    "auth_type",
    "tool_count",
    "prompt_count",
    "connected_for_project",
    "scope",
    "allowed_tools",
    "config",
    "execution_mode",
    "config_schema",
    "project_connections",
    "project_user_connections",
    "resolution"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_project_integration 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_project_integration` 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.