# Get Customiser Links (`get_customiser_links`)

Returns the settings of the Store hosted Customiser Links page: the page a quote-mode customiser gets at its own link, which shoppers open without a storefront. It reports whether the page is on, the Back to Store address, the background colour and the logo URL. A Store that has never saved the page reads as off with no branding. It requires the store:read scope, has no side effects and is safe to retry.

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

## Purpose

Read the Customiser Links page settings before changing them with update_store.

## Annotations

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

## Prerequisites

- A merchant has connected this store and approved the store:read scope.

## Arguments

This tool takes no arguments.

## Result

One Customiser Links object.

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `request_id` | string | yes |  |
| `store` | object | yes |  |
| `store.id` | integer | yes |  |
| `store.name` | string | yes |  |
| `enabled` | boolean | yes | Whether the Customiser Links pages are on. |
| `return_url` | string or null | no | The address the Back to Store link opens, or null when the page has no such link. |
| `theme_colour` | string or null | no | The page background colour as #RRGGBB, or null for white. |
| `logo_url` | string or null | no | The page logo URL, or null when the page has no logo. |
| `updated_at` | string or null | no | When the settings last changed, in ISO 8601 UTC, or null when they were never saved. |

## Error cases

| Code | Recovery |
| --- | --- |
| `insufficient_scope` | The connection was approved without store:read. Ask the merchant to reconnect and approve it, or to remove the connector and add it again if the approval screen does not offer it. |

## Example: Read the page settings

Request:

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

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "enabled": true,
      "return_url": "https://demosigns.example",
      "theme_colour": "#FFFFFF",
      "logo_url": "https://cdn.signcustomiser.com/files/8a1d4c2e.png",
      "updated_at": "2026-11-02T09:30:00Z"
    }
  }
}
```

## Example: The connection was not granted store:read (error)

Request:

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

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "insufficient_scope",
        "title": "Insufficient scope",
        "detail": "The tool [get_customiser_links] requires the store:read scope, which this connection was not granted.",
        "recovery": "The connection was authorised without the scope this tool needs. Ask the merchant to reconnect the Sign Customiser connector and approve the scope named in required_scopes. If the approval screen does not offer that permission, ask them to remove the connector from this AI agent and add it again. Do not retry this call.",
        "required_scopes": [
          "store:read"
        ],
        "granted_scopes": [
          "customisers:read"
        ]
      }
    }
  }
}
```
