SIGNALS Docs
Exit Reader View
100%
Theme

MCP & CLI

Enable the Signals API MCP server and signals:api Artisan CLI, and copy connector install instructions.

Overview

MCP & CLI is the admin settings screen for the AI connector surface and the in-process API CLI. Self-hosted installs turn each transport on here before clients can connect.

On Signals Cloud, this screen is named MCP and the API CLI section is not available.

Where it lives

Route: /admin/settings/mcp-cli (admin.settings.mcp-cli)

Open Admin → Users & Security → MCP & CLI. Requires settings.manage.

Settings

Group Keys Effect
mcp enabled, http_enabled, stdio_enabled Master switch plus per-transport gates for the MCP server
mcp read_only Restricts MCP to reads — write tools disappear from tools/list and execute-endpoint refuses anything but GET/HEAD. See read-only mode
mcp execute_endpoint_enabled Shows or hides the open-world execute-endpoint tool. Direct calls are refused while disabled. Sanctum PATs also require mcp:execute.
mcp session_unit_budget Weighted API units one MCP session may spend before every further tool call returns a normal budget-exhausted result. 0 (default) = unlimited. See session unit budget
api_cli enabled Master switch for php artisan signals:api

When MCP HTTP is enabled, the page shows the install URL (/mcp/api) and copy-paste instructions for Claude, Claude Code, and ChatGPT. Tokens are minted on API Tokens; the token owner needs mcp.access, and tokens allowed to use execute-endpoint need mcp:execute as well. Mutating CLI calls require cli.access on their acting user.

Branding and colour API access

The branding and colour settings groups can be read separately without granting a token access to every setting. Use settings:read:branding for company colours/logo metadata and settings:read:colour for availability and diary colours; broad settings:read remains the all-groups ability.

php artisan signals:api call api.v1.settings.show --token="$SIGNALS_PAT" --param="group=branding"
php artisan signals:api call api.v1.settings.show --token="$SIGNALS_PAT" --param="group=colour"

The equivalent MCP execute-endpoint call uses route name api.v1.settings.show with path_params: {"group":"branding"} or {"group":"colour"}. Partial writes use api.v1.settings.update, require settings.manage plus settings:write, and wrap changed keys inside body.settings. See the worked examples in API CLI and MCP server.

For account capabilities and refusals, see Accounts.