# Get integration (`get_integration`)

Reads one commerce integration of the connected Store: its id, platform type, name, whether it is enabled, whether it accepts order and product writes, and its settings that are not credentials. Tokens and secrets are never returned. It cannot change the integration. It requires the integrations:read scope and has no side effects.

- Source URL: https://www.signcustomiser.com/help/mcp/tools/get_integration/
- Markdown URL: https://www.signcustomiser.com/help/mcp/tools/get_integration.md
- MCP endpoint: https://mcp.signcustomiser.com
- Required scope: `integrations:read`
- Behaviour: read

## Purpose

Check how one integration is set up, for example which address a custom integration sends new products to.

## Annotations

| Hint | Value |
| --- | --- |
| readOnlyHint | true |
| destructiveHint | false |
| idempotentHint | true |
| openWorldHint | false |

## Prerequisites

- An integration id from list_integrations or get_store.
- A merchant has connected this store and approved the integrations:read scope.

## Arguments

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `integration_id` | integer | yes | The integration id, from list_integrations. |

## Result

The integration with its type-specific settings.

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `request_id` | string | yes |  |
| `store` | object | yes |  |
| `store.id` | integer | yes |  |
| `store.name` | string | yes |  |
| `integration` | object | yes | The integration. |
| `integration.id` | integer | yes |  |
| `integration.type` | string | yes | Expected to grow. One of: `shopify`, `woocommerce`, `wix`, `etsy`, `custom`. |
| `integration.name` | string | yes |  |
| `integration.enabled` | boolean | yes |  |
| `integration.accepts_writes` | boolean | yes | True only for an enabled custom integration, the kind create_order and create_integration_product accept. |
| `integration.settings` | object | yes | The settings of the integration type, never its credentials, tokens or platform session ids. Each type carries only its own keys, and a key that is not set is null. |
| `integration.settings.api_url` | string or null | no | woocommerce only: the address of the WooCommerce store, as its scheme, host, port and path only (no user name, password, path parameter, query string or fragment). |
| `integration.settings.create_product_url` | string or null | no | custom only: the address Sign Customiser sends new products to, as its scheme, host, port and path only (no user name, password, path parameter, query string or fragment). |
| `integration.settings.domain` | string or null | no | shopify only: the myshopify.com domain of the Shopify store. |
| `integration.settings.publication_id` | string or null | no | shopify only: the Shopify publication new products are published to, or null for the default. |
| `integration.settings.default_product_status` | string or null | no | shopify only: the status new products get on Shopify (closed). One of: `active`, `unlisted`. |
| `integration.settings.version` | string or null | no | wix only: the Wix catalogue version (closed), or null before it is known. One of: `v1`, `v3`. |
| `integration.settings.managed_by` | string or null | no | etsy only: what manages the integration. |

## Error cases

| Code | Recovery |
| --- | --- |
| `insufficient_scope` | The connection was approved without integrations:read. |
| `resource_not_found` | No integration with that id belongs to this store. Call list_integrations to find a valid id. |

## Example: Read a custom integration

Request:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_integration",
    "arguments": {
      "integration_id": 32
    }
  }
}
```

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "integration": {
        "id": 32,
        "type": "custom",
        "name": "Workshop system",
        "enabled": true,
        "accepts_writes": true,
        "settings": {
          "create_product_url": "https://workshop.example.com/sign-customiser/products"
        }
      }
    }
  }
}
```

## Example: An integration of another store (error)

Request:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_integration",
    "arguments": {
      "integration_id": 999
    }
  }
}
```

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "resource_not_found",
        "title": "Resource not found",
        "detail": "The requested resource does not exist or does not belong to the authenticated store.",
        "recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
      }
    }
  }
}
```
