Sends real-time updates and styled content to display boards on iOS and Android devices from an AI agent or terminal.
Also known as pushtodisplay/cli, pushtodisplay
- Stars
- 2
- Tools
- 8
- Downloads, 30 days
- —
- Latest version
- 0.1.14
- Last commit
- Nov 8, 2026
- License
- MIT
What is PushToDisplay MCP?
PushToDisplay sends real-time updates and styled content to display boards on iOS and Android devices from an AI agent or terminal. It exposes 8 tools, such as pushtodisplay_send_update, pushtodisplay_list_boards, pushtodisplay_get_board.
Summary generated from the project's README
About PushToDisplay MCP server
Pushing real-time updates and styled content to mobile display boards from an AI agent is what this MCP server enables. It allows developers and automated systems to turn iOS and Android devices into live status dashboards by sending text and visual updates directly from a terminal or an AI client like Claude, Cursor, or VS Code Copilot.
Users can manage their displays through several specialized tools, including pushtodisplay_send_update for broadcasting messages, pushtodisplay_list_boards to view existing setups, and pushtodisplay_create_board for new layouts. The server inherits authentication from the existing CLI session, which can be established via a browser login or a device code for headless environments like SSH or containers. For automated CI/CD pipelines, authentication can be handled using an API key starting with the pt_ prefix.
This server provides granular control over how information appears on a screen. You can specify text size, font weight, hex colors, and background colors, or target specific panels within a multi-panel layout. It supports complex styling through JSON blocks and allows for horizontal or vertical alignment to ensure information is presented clearly on the mobile device.
What you can do with it
- 1Broadcast deployment status updatesAn AI agent can send a notification to a specific board when a software deployment succeeds or fails.
- 2Monitor infrastructure health visuallyDevelopers can use the server to push color-coded uptime or API health metrics to a mobile dashboard.
- 3Manage display board configurationsAn AI assistant can create, list, or delete different display boards to organize various monitoring tasks.
- 4Automate status displays in CI/CDAutomated scripts can use an API key to send real-time logs or build results to a mobile screen without interactive login.
Written from the project's README. Every use case is checked against a quote from it.
How to install PushToDisplay MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall PushToDisplay MCP in Claude Code
$ claude mcp add cli -- npx -y pushtodisplayInstall PushToDisplay MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"cli": {
"command": "npx",
"args": [
"-y",
"pushtodisplay"
]
}
}
}Install PushToDisplay MCP in VS Code
.vscode/mcp.json
{
"servers": {
"cli": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"pushtodisplay"
]
}
}
}Install PushToDisplay MCP in VS Code CLI
$ code --add-mcp '{"name":"cli","type":"stdio","command":"npx","args":["-y","pushtodisplay"]}'Install PushToDisplay MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"cli": {
"command": "npx",
"args": [
"-y",
"pushtodisplay"
]
}
}
}Install PushToDisplay MCP in Codex
$ codex mcp add cli -- npx -y pushtodisplayInstall PushToDisplay MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.cli] command = "npx" args = ["-y", "pushtodisplay"]
Install PushToDisplay MCP in Gemini CLI
$ gemini mcp add -s user cli npx -- -y pushtodisplayInstall PushToDisplay MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"cli": {
"command": "npx",
"args": [
"-y",
"pushtodisplay"
]
}
}
}PushToDisplay MCP tools 8
Detected from the READMEpushtodisplay_send_updatepushtodisplay_list_boardspushtodisplay_get_boardpushtodisplay_create_boardpushtodisplay_update_boardpushtodisplay_set_default_boardpushtodisplay_delete_boardpushtodisplay_list_devices
| pushtodisplay_send_update | — | |
| pushtodisplay_list_boards | — | |
| pushtodisplay_get_board | — | |
| pushtodisplay_create_board | — | |
| pushtodisplay_update_board | — | |
| pushtodisplay_set_default_board | — | |
| pushtodisplay_delete_board | — | |
| pushtodisplay_list_devices | — |
Configuration
PTD_API_KEY
| Name | Description | |
|---|---|---|
| PTD_API_KEY | — |
Automated checks
Ran Nov 12, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packagePass
- Remote endpoint uses HTTPSNot checked
- Destructive tools are labelledPass
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesPass
README
View on GitHubpushtodisplay
Command-line interface and MCP server for Push To Display — send real-time updates to display boards from your terminal or AI agents.

Get the app
Turn any screen into a live display board — get Push to Display on iOS and Android.
Install
Run directly with npx (no install needed):
npx pushtodisplay --help
Or install globally:
npm install -g pushtodisplay
Requires Node.js 18+. See the PushToDisplay documentation for guides, use cases, and API details.
Quick start
# Log in (opens browser)
pushtodisplay auth login
# Send an update (uses your default board)
pushtodisplay send "Hello, Display!"
# Send to a specific board
pushtodisplay send -b <board-id> "Deploy completed"
# List your boards
pushtodisplay boards list
Authentication
Log in with your Push To Display account — the same account you use in the mobile app.
Browser login (default)
pushtodisplay auth login
Opens your browser. Sign in and the CLI receives your credentials automatically.
Device code login (headless)
For machines without a browser — SSH sessions, containers, or remote servers:
pushtodisplay auth login --device-code
The CLI prints a URL and a one-time code. Open the URL on any device, enter the code, and approve the login.
Credentials are stored in your OS keychain (macOS Keychain, Linux libsecret, Windows Credential Manager). Falls back to ~/.config/pushtodisplay/ if the keychain is unavailable.
# Check auth status
pushtodisplay auth status
# Machine-readable status for scripts/agents (exit 0 = authenticated)
pushtodisplay auth status --json
# Log out (clear stored credentials)
pushtodisplay auth logout
auth status reports effective auth: an expired access token is still
reported as authenticated when a valid refresh token can renew it transparently
(a will refresh automatically note is shown instead of the raw token expiry).
It exits 0 when authenticated and 1 when not, so it is safe to gate
scripts on it.
{
"authenticated": true,
"method": "oauth",
"accessTokenExpired": true,
"canRefresh": true,
"sessionExpiresAt": "2026-06-01T00:00:00.000Z"
}
Commands
send
Send a display update to a board.
# Simple text
pushtodisplay send -b my-board-id "Deploy succeeded"
# Styled text
pushtodisplay send -b my-board-id "Status" --size large --weight bold --color "#00FF00"
# Multiple inline runs — they stay on ONE line
pushtodisplay send -b my-board-id "Build:" "passing" --color "#22C55E"
# Panel targeting with layout options
pushtodisplay send -b my-board-id --panel 2 "Right panel content"
pushtodisplay send -b my-board-id --panel 1 --full-panel --density compact --align-x center "Alert"
# Per-run styling with JSON (repeatable)
pushtodisplay send -b my-board-id \
--block '{"text": "API Health", "size": "large", "weight": "bold"}' \
--block '{"text": "Uptime: 99.97%", "color": "#22C55E"}'
# Pipe a full JSON payload from stdin
echo '{"boardId":"my-board-id","blocks":[{"text":"From pipe"}]}' | pushtodisplay send --stdin
If no -b flag is provided, the server uses your default board.
How text renders
Blocks are inline runs, not lines. Think of <span>, not <p>. The blocks
of one message flow onto a single line in order, and wrap like a paragraph when
they run out of width:
pushtodisplay send -b my-board-id "Build:" "passing" --color "#22C55E"
renders as one line:
Build: passing
not as two lines. Each run keeps its own size, weight, colour, and background, so a message is one paragraph with styled runs inside it.
To put content on separate lines, send separate messages. Every send is its own entry in the panel's scrollable history, so multiple lines are multiple messages. Newlines inside a single message are not a layout mechanism.
--density sets the line height used when that paragraph wraps — it is not
the spacing between messages.
Note: in
--full-panelmode blocks are currently stacked on separate lines. That legacy behaviour is being removed so full-panel matches the inline model above.
Style flags
| Flag | Values | Description |
|---|---|---|
-s, --size |
small, medium, large |
Text size |
-w, --weight |
regular, semibold, bold |
Font weight |
-c, --color |
Hex color (#RRGGBB) |
Text color |
--background |
Hex color (#RRGGBB) |
Background color |
Panel flags
| Flag | Values | Description |
|---|---|---|
-p, --panel |
1–4 |
Target panel number |
--full-panel |
— | Enlarge to the whole board |
--density |
compact, standard, spacious |
Line height when text wraps |
--align-x |
start, center, end |
Horizontal alignment |
--align-y |
start, center, end |
Vertical alignment |
Other flags
| Flag | Description |
|---|---|
-b, --board |
Board ID |
--block <json> |
Inline styled run as JSON (repeatable) |
--stdin |
Read full JSON request from stdin |
boards
pushtodisplay boards list # List all boards
pushtodisplay boards get <id> # Get board details
pushtodisplay boards create -n "Name" # Create a board
pushtodisplay boards create -n "Dash" -l 4 # Create with a layout
pushtodisplay boards delete <id> # Delete a board
Create options:
| Flag | Description |
|---|---|
-n, --name |
Board name (required) |
-d, --description |
Board description |
-l, --layout |
Layout ID |
devices
pushtodisplay devices list # List active device-board streams
config
pushtodisplay config # Show current configuration
pushtodisplay config show # Same as above
JSON output
Add --json to any command for machine-readable output:
pushtodisplay boards list --json
pushtodisplay send -b my-board "test" --json
Configuration
Configuration is resolved in order: environment variables → config file → defaults.
| Env var | Description | Default |
|---|---|---|
PTD_API_URL |
API endpoint | https://api.pushtodisplay.com |
PTD_SERVICE_URL |
Service endpoint | https://services.pushtodisplay.com |
PTD_IDP_URL |
Identity provider | https://idp.pushtodisplay.com |
PTD_CONFIG_DIR |
Config directory | ~/.config/pushtodisplay |
MCP server
The CLI includes a built-in Model Context Protocol server, giving AI agents (Claude, Cursor, VS Code Copilot, and others) direct access to your display boards.
The MCP server inherits your CLI session — if you've run pushtodisplay auth login, it authenticates automatically.
Setup
Claude Code
claude mcp add pushtodisplay -- npx pushtodisplay mcp
Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"pushtodisplay": {
"command": "npx",
"args": ["pushtodisplay", "mcp"]
}
}
}
Cursor
Open Settings → MCP Servers → Add Server, or edit .cursor/mcp.json:
{
"mcpServers": {
"pushtodisplay": {
"command": "npx",
"args": ["pushtodisplay", "mcp"]
}
}
}
VS Code (GitHub Copilot)
Add to .vscode/mcp.json:
{
"servers": {
"pushtodisplay": {
"command": "npx",
"args": ["pushtodisplay", "mcp"]
}
}
}
Other MCP clients
Any MCP client that supports stdio transport can use Push To Display. The server command is:
npx pushtodisplay mcp
Available MCP tools
| Tool | Description |
|---|---|
pushtodisplay_send_update |
Send content to a board |
pushtodisplay_list_boards |
List all boards |
pushtodisplay_get_board |
Get details of a board |
pushtodisplay_create_board |
Create a new board |
pushtodisplay_update_board |
Update a board's name, description, or layout |
pushtodisplay_set_default_board |
Set a board as your default |
pushtodisplay_delete_board |
Delete a board permanently |
pushtodisplay_list_devices |
List active device connections |
Commands at a glance
| Command | Description |
|---|---|
auth login |
Log in (browser or device code) |
auth logout |
Remove stored credentials |
auth status |
Show current auth status |
send [text...] |
Send a display update |
boards list |
List your boards |
boards get <id> |
Get board details |
boards create |
Create a new board |
boards delete <id> |
Delete a board |
devices list |
List active device connections |
config |
Show current configuration |
mcp |
Start the MCP server |
API key authentication
For CI/CD pipelines and scripts where interactive login isn't available, you can authenticate with an API key. Create one from the mobile app or the web portal. API keys start with pt_.
# Via environment variable
export PTD_API_KEY=pt_your_key_here
pushtodisplay send "From CI"
# Or store in keychain
pushtodisplay auth login --api-key pt_your_key_here
Note: API key auth only supports the
sendcommand. Useauth loginfor full access to boards, devices, and config management.
Screenshots
4-panel layout — regional status at a glance
Multi-panel with CI/CD pipeline and infrastructure logs
Incident timeline with color-coded severity
License
PushToDisplay MCP questions
How do I add PushToDisplay MCP to Claude Code?
Run claude mcp add cli -- npx -y pushtodisplay in your terminal. Add --scope user to make it available in every project.
How do I add PushToDisplay MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does PushToDisplay MCP provide?
It exposes 8 tools, including pushtodisplay_send_update, pushtodisplay_list_boards, pushtodisplay_get_board, pushtodisplay_create_board, pushtodisplay_update_board.
Can I use an API key for CI/CD pipelines?
Yes, you can authenticate using an API key starting with 'pt_' via an environment variable or the CLI, though API key authentication only supports the send command.
How does the MCP server handle authentication?
The MCP server inherits your existing CLI session; if you have already logged in via the CLI, it authenticates automatically.
