mcp-server-awtrix
MCP Server Awtrix: Ulanzi 및 픽셀 시계를 위한 AI 에이전트 디스플레이 오케스트레이터
MCP Server Awtrix (mcp-server-awtrix)는 AI 에이전트(Antigravity, Claude Desktop, Cursor, Cline, AutoGPT 등)가 Awtrix Light를 실행하는 Ulanzi TC001 및 호환 픽셀 매트릭스 스마트 시계를 완전히 제어할 수 있도록 설계된 오픈소스 Model Context Protocol (MCP) 서버이자 선언형 메트릭 오케스트레이터입니다.
대화형 및 자율형 AI 에이전트와 물리적 데스크톱 디스플레이를 연결하여 다음을 지원합니다:
즉시 에이전트 알림: 임시 상태 알림, 빌드 실패 알림, 작업 완료 메시지를 픽셀 화면에 푸시합니다.
동적 캐러셀 앱: 사용자 지정 실시간 텔레메트리 앱(서버 상태, SaaS 지표, 매출 카운터, 빌드 상태)을 등록, 업데이트, 순환 표시합니다.
선언형 메트릭 폴러: 개별 Python 스크립트 작성 없이 YAML 사양을 통해 백그라운드 API 폴링 및 임계값 포맷 지정을 자동화합니다.
하드웨어 텔레메트리 및 제어: 배터리 잔량, 매트릭스 밝기, 전원 상태를 확인·관리하고 사용자 지정 사운드 큐를 트리거합니다.
목차
Related MCP server: pixoo-mcp-server
1. 제품 요구사항 문서(PRD)
문제 정의
Awtrix Light를 실행하는 Ulanzi TC001 등 스마트 픽셀 시계를 사용하는 개발자와 파워유저는 현재 외부 API를 조회하고 매트릭스 앱을 갱신하기 위해 분산되고 하드코딩된 Python 또는 Bash cron 스크립트를 작성하고 있습니다.
AI 코딩 에이전트와 함께 작업할 때:
에이전트는 모든 메트릭에 대해 원시 명령형 코드를 생성하고 유지해야 합니다.
AI 에이전트가 실시간 알림을 보내거나 디스플레이 수명 주기를 관리할 수 있는 표준화된 도구 세트가 없습니다.
비밀 관리가 오류에 취약하여 AI 프롬프트와 로그에 API 키가 유출될 위험이 있습니다.
여러 세그먼트의 텍스트 포맷 및 픽셀 아이콘에 대한 기본 폴백 혹은 검증 기능이 없습니다.
목표 및 비목표
목표
네이티브 MCP 인터페이스: 알림, 사용자 지정 앱, 기기 관리, 미리보기를 위한 강력한 도구를 제공하는 표준 Model Context Protocol 서버를 제공합니다.
선언형 텔레메트리: 에이전트와 사용자가 내장 템플릿(Jinja2)과 임계값 서식을 활용해 간단한 YAML 파일로 메트릭 폴링 규칙을 정의할 수 있습니다.
안전한 비밀정보 분리:
.env환경 변수 치환을 통해 민감한 자격 증명을 프롬프트 컨텍스트에서 분리합니다.무중단 핫 리로드: 서비스 재시작 없이 YAML 구성 파일의 변경 사항을 자동으로 반영합니다.
안정적 폴백: 네트워크 중단, API 속도 제한, 오프라인 디스플레이 상태를 원활하게 처리합니다.
비목표
Awtrix Light 펌웨어 대체(이 도구는 공식 Awtrix Light REST/MQTT API와만 상호 운용됩니다).
복잡한 멀티 모니터 타일 동기화(단일 또는 다중 인스턴스 독립형 픽셀 시계에 초점).
대상 페르소나 및 사용 사례
페르소나 | 시나리오 | MCP Server Awtrix가 도움이 되는 방법 |
AI 코딩 에이전트 (예: Antigravity / Cursor) | 에이전트가 백그라운드에서 10분 동안의 테스트 스위트 또는 자율 작업을 완료합니다. |
|
DevOps / SRE 엔지니어 | 프로덕션 가동 시간, 오류 예산, Checkly 합성 테스트를 모니터링하려 합니다. |
|
SaaS 창업자 / 비builder | 책상 위 시계에 실시간 MRR, 신규 사용자 가입 수, 지원 티켓 카운터가 순환되기를 바랍니다. | 백엔드 관리자 엔드포인트를 조회하는 선언적 다중 지표 앱을 정의합니다. |
기능 요구사항
FR-1: 즉시 알림 (
/api/notify):사용자 정의 텍스트, 여러 세그먼트의 컬러 텍스트, 아이콘 ID, 사운드/RTTTL 벨소리, 우선 순위 유지(hold), 지속 시간을 지원합니다.
FR-2: 사용자 지정 캐러셀 앱 (
/api/custom):디스플레이 루프에서 이름이 지정된 앱을 등록, 갱신, 제거할 수 있습니다.
리치 텍스트 세그먼트 포맷을 지원합니다. (
[{"t": "FAIL", "c": "FF0000"}, {"t": " (2/10)", "c": "FFFFFF"}]).
FR-3: 선언적 백그라운드 엔진:
apps/*.yaml에 정의된 폴링 작업을 실행하는 내장 스케줄러(asyncio/apscheduler)를 포함합니다.계산된 변수, 산술 및 조건부 표현식을 지원하는 템플릿 엔진을 제공합니다.
FR-4: 기기 상태 및 텔레메트리:
배터리 잔량, Wi-Fi RSSI, 조도 센서, 매트릭스 상태 및 활성 앱을 조회합니다.
밝기, 수면/활성 상태 및 전환 효과를 조정합니다.
FR-5: 드라이런(Dry-Run) 및 시뮬레이션:
하드웨어 전송 전에 정확한 렌더링 JSON 페이로드와 색상 검증을 반환하는 미리보기 도구를 제공합니다.
비기능 요구사항
지연 시간: 직접 MCP 도구 실행은 로컬 네트워크에서 Awtrix까지 $< 150\text{ms}$ 이내에 전달되어야 합니다.
복원력: 오케스트레이터는 실패한 API 호출을 지연 시간을 늘려가며 재시도한 후 해당 앱을 성능 저하(degraded) 상태로 표시합니다.
이식성:
uv/pipx지원, Docker 컨테이너 및 독립 실행형 CLI가 포함된 표준 Python 패키지로 제공됩니다.
2. 시스템 아키텍처 및 설계
상위 수준 아키텍처
┌──────────────────────────┐
│ AI Client/Host │
│ (Claude / Antigravity / │
│ Cursor / Cline) │
└────────────┬─────────────┘
│
│ stdio / SSE (MCP Protocol)
▼
┌────────────────────────────────────────────────────────────────────────────────────────┐
│ mcp-server-awtrix │
│ │
│ ┌───────────────────────┐ ┌──────────────────────────────┐ ┌───────────────────┐ │
│ │ MCP Interface │ │ App Orchestrator │ │ Config Watcher │ │
│ │ (Tools / Resources) │ │ (Async Scheduler) │ │ (Hot-Reload) │ │
│ └───────────┬───────────┘ └──────────────┬───────────────┘ └─────────┬─────────┘ │
│ │ │ │ │
│ ▼ ▼ ▼ │
│ ┌──────────────────────────────────────────────────────────────────────────────────┐ │
│ │ Core Engine & Driver │ │
│ │ - Schema Validator (Pydantic) │ │
│ │ - Template & Expression Engine (Jinja2 / JSONPath) │ │
│ │ - Secret Resolver (.env) │ │
│ │ - Awtrix REST / WebSocket Client │ │
│ └──────────────────────────────────────────┬───────────────────────────────────────┘ │
└─────────────────────────────────────────────┼──────────────────────────────────────────┘
│
│ HTTP REST (JSON)
▼
┌──────────────────────────┐
│ Ulanzi TC001 Clock │
│ (Awtrix Light Firmware)│
└──────────────────────────┘컴포넌트 구성
MCP 인터페이스 계층:
stdio및SSE를 통해 Model Context Protocol 서버 엔포인트를 구현합니다.AI 모델이 사용할 수 있도록 엄격한 JSON 스키마와 사람이 읽기 쉬운 문서와 함께 도구를 노출합니다.
선언적 폴링 엔진:
파일 기반 앱 매니페스트에 대한 작업 수명 주기를 관리하는 비동기 작업자입니다.
HTTP 요청을 평가하고 JSONPath/표현식을 사용해 필드를 추출하며 표시 규칙을 판별합니다.
Awtrix Driver:
기기 통신, 요청 중복 제거, 연결 풀링 및 오류 복구를 캡슐화합니다.
구성 및 보안 계층:
민감한 토큰을
.env에 분리합니다. 구성 파일은${VAR_NAME}구문에서 변수를 참조합니다.
3. MCP 도구 사양
AI 에이전트는 다음 MCP 도구를 실행할 수 있습니다:
awtrix_notify
현재 캐러셀을 중단하고 화면에 즉시 높은 우선순위의 알림을 표시합니다.
{
"text": "Build Failed: Backend API",
"icon": "10558",
"color": "FF0000",
"duration": 8,
"sound": "alarm",
"rtttl": "beep:d=4,o=5,b=100:16e6,16e6",
"wakeup": true
}awtrix_upsert_app
캐러셀 루프에 지속적인 사용자 지정 앱을 등록하거나 업데이트합니다.
{
"name": "app_users",
"text": [
{"t": "1,420", "c": "FFFFFF"},
{"t": " (+42)", "c": "00FF00"}
],
"icon": "2058",
"duration": 5,
"lifetime": 300
}awtrix_delete_app
기기 순환 목록에서 사용자 지정 앱을 제거합니다.
{
"name": "app_users"
}awtrix_get_device_state
하드웨어 통계와 현재 운영 지표를 반환합니다.
응답:
{
"online": true,
"battery": 88,
"charging": true,
"lux": 140,
"temp": 24,
"ram_free": 128440,
"active_app": "app_users",
"brightness": 120
}awtrix_set_settings
밝기, 매트릭스 소등, 전환 속도 등의 기기 매개 변수를 구성합니다.
{
"brightness": 80,
"power": true
}awain / dry-run 자
{
"brightness": 80,
"power": true
}awtrix_test_render
표현식을 파싱하고 하드웨어에 전송하지 않고 렌더링된 페이로드를 반환하는 dry-run 헬퍼입니다.
4. 선언적 앱 엔진(YAML 스키마)
별도의 Python 스크립트를 유지하는 대신 apps/ 디렉터리에 .yaml 매니페스트를 두면 됩니다.
예시 1: 서비스 상태(Checkly)
apps/checkly.yaml
app_id: "checkly"
name: "checkly_status"
enabled: true
interval_seconds: 60
source:
type: "http"
url: "https://api.checklyhq.com/v1/checks"
headers:
Authorization: "Bearer ${CHECKLY_API_KEY}"
X-Checkly-Account: "${CHECKLY_ACCOUNT_ID}"
transform:
total: "len(data)"
failures: "sum(1 for c in data if c.get('hasFailures'))"
degraded: "sum(1 for c in data if c.get('isDegraded') and not c.get('hasFailures'))"
display:
- condition: "failures > 0"
icon: "10558"
notify: true
text:
- { text: "FAIL ", color: "FF0000" }
- { text: "({{failures}}/{{total}})", color: "FFFFFF" }
- condition: "degraded > 0"
icon: "10558"
text:
- { text: "WARN ", color: "FFA500" }
- { text: "({{degraded}}/{{total}})", color: "FFFFFF" }
- condition: "default"
icon: "483"
text:
- { text: "UP ", color: "00FF00" }
- { text: "({{total}})", color: "FFFFFF" }예시 2: 다중 지표 SaaS 대시보드
apps/saas_metrics.yaml
app_id: "saas_metrics"
interval_seconds: 120
source:
type: "http"
url: "https://api.example.com/v1/admin/metrics"
headers:
X-API-Secret: "${SAAS_METRICS_API_SECRET}"
sub_apps:
- name: "app_users"
icon: "2058"
text:
- { text: "{{data.users_total}}", color: "FFFFFF" }
- { text: " (+{{data.new_users_last_week}})", color: "00FF00" }
- name: "app_premium"
icon: "5336"
text:
- { text: "{{data.users_premium}}", color: "FFFFFF" }
- { text: " (+{{data.new_users_premium_last_week}})", color: "FFD700" }
- name: "app_orders"
icon: "21072"
text:
- { text: "{{data.orders_total}}", color: "FFFFFF" }
- { text: " (+{{data.new_orders_last_week}})", color: "00FF00" }
- name: "app_support"
icon: "10558"
show_if: "data.tickets_open > 0"
text:
- { text: "{{data.tickets_open}}", color: "FF0000" }5. 빠른 시작 및 설치
사전 요구 사항
Python 3.10 이상
Awtrix Light Firmware가 설치되어 Wi-Fi 네트워크에 연결된 Ulanzi TC001(또는 호환 기기).
uv / pip 로컬 설정
# Clone the repository
git clone https://github.com/klodnickik/mcp-server-awtrix.git
cd mcp-server-awtrix
# Copy example environment configuration
cp .env.example .env
# Edit device address and API keys in .env
# AWTRIX_BASE_URL=http://awtrix3.localMCP 서버를 stdio로 로컬에서 돌립니다:
# Using uv (recommended)
uv run mcp-server-awtrix
# Or standard pip
pip install -e .
python -m awtrix_mcpDocker 및 Docker Compose 설정
Docker Compose로 실행:
# 1. Clone & prepare environment
git clone https://github.com/klodnickik/mcp-server-awtrix.git
cd mcp-server-awtrix
cp .env.example .env
# 2. Start the MCP Server (SSE on port 8000) and Metric Daemon
docker compose up -d
# Or start only the metric poller daemon:
docker compose up -d metric-daemon
# View live logs:
docker compose logs -fMCP 클라이언트 구성
1. Google Antigravity
mcp_servers.json에 다음을 추가하세요:
{
"mcpServers": {
"awtrix": {
"command": "uv",
"args": ["--directory", "/path/to/mcp-server-awtrix", "run", "mcp-server-awtrix"],
"env": {
"AWTRIX_BASE_URL": "http://awtrix3.local"
}
}
}
}2. Claude Desktop
claude_desktop_config.json에 다음을 추가하세요:
{
"mcpServers": {
"awtrix": {
"command": "python",
"args": ["-m", "awtrix_mcp"],
"env": {
"AWTRIX_BASE_URL": "http://awtrix3.local"
}
}
}
}3. Cursor
Cursor 설정 $\rightarrow$ 기능 $\rightarrow$ MCP 서버 $\rightarrow$ 서버 추가 에서:
이름:
awtrix유형:
command명령어:
uv --directory /path/to/mcp-server-awtrix run mcp-server-awtrix
6. 로드맵 및 기여
핵심 MCP 도구 사양 및 설계
선언적 YAML 오케스트레이션 스키마
빠른 FastMCP 구현
라이브 매트릭스 픽셀 아트 웹 사전 뷰
MQTT 전송 계층 지원(REST 대안 선택)
Home Assistant 서비스 발견 내보내기
기여는 언제나 환영입니다! 기능 논의를 위해 PR을 제출하거나 이슈를 열어주세요.
7. 라이선스
MIT 표준 라이선스로 배포됩니다. 자세한 내용은 LICENSE를 참조하세요.
Available Tools
6 toolsawtrix_delete_appADestructiveIdempotent
Remove a custom app from the display cycle by name.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint and destructiveHint, so the core behavioral safety profile is covered. The description adds context beyond the annotations by specifying exactly what is destroyed or affected: a custom app's presence in the display cycle. No contradiction exists between the description and annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no filler. It states the action, target, scope, and parameter mechanism efficiently.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple: one required parameter, an output schema is present, and annotations cover idempotency and destructive behavior. The description covers the essential target and parameter. Minor gaps remain around exact-name matching and the precise meaning of 'from the display cycle', but nothing critical is missing for basic invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and the description only indicates that removal happens 'by name'. This adds meaning beyond the raw schema by relating the 'name' parameter to the custom app identifier, but it does not clarify expected format, uniqueness, or matching behavior. For a single simple parameter, this is adequate but minimal.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Remove'), identifies the exact resource ('a custom app from the display cycle'), and specifies the selection mechanism ('by name'). This clearly distinguishes it from sibling tools like awtrix_upsert_app, which creates or updates an app rather than deleting it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance is given about when to use this tool versus alternatives, nor are exclusions or prerequisites mentioned. The intended use is only implied by the tool's name and purpose, not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
awtrix_get_device_stateARead-onlyIdempotent
Return current AWTRIX hardware metrics: battery, lux, temperature, active app (if available).
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, so the safety profile is covered. The description adds useful behavioral nuance by saying 'current' and 'if available,' signaling that values may change over time and that the active app field can be absent. This is meaningful context beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, well-structured sentence states the action and the list of returned metrics with no filler. The most important scoping word ('current') appears upfront, and the optionality of the active app is handled compactly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no parameters, an output schema present, and annotations covering idempotence/read-only behavior, the description is sufficient for an agent to invoke the tool correctly. It states exactly what hardware metrics will be returned and does not need to cover return formatting because the output schema exists.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the description has no parameter burden to carry. The baseline for zero-parameter tools is 4, and there is nothing here that reduces the score; the description instead clarifies what the returned metrics are.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Return') and names the exact resource: current AWTRIX hardware metrics (battery, lux, temperature, active app). It clearly distinguishes this read-only tool from the mutating/action siblings like awtrix_delete_app, awtrix_notify, and awtrix_upsert_app without needing to open the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description makes it clear this is the status/read tool by saying 'Return current...' while all sibling tools are actions or mutations. It does not explicitly state when not to use it, but the context is clear enough that an agent would select this for reading hardware state rather than for changing anything.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
awtrix_notifyB
Push an instant, high-priority notification to the AWTRIX display.
| Name | Required | Description | Default |
|---|---|---|---|
| hold | No | ||
| icon | No | ||
| text | Yes | ||
| color | No | ||
| rtttl | No | ||
| sound | No | ||
| stack | No | ||
| wakeup | No | ||
| duration | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already communicate open-world behavior and non-idempotency, and the description adds that the notification is pushed instantly with high priority. It does not disclose auth needs, rate limits, or stacking/replacement behavior, but it does not contradict the annotations either.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence that states the essential action and destination with no filler. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The core call is clear, but the description is minimal for a tool with 9 parameters and several sibling tools. It does not explain optional parameter relationships, duplicate-notification behavior, or when to prefer test_render; the presence of an output schema and annotations softens but does not fill these gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and the description provides no prose about any of the 9 parameters. The schema's names and defaults are somewhat informative, but the description fails to compensate for the coverage gap, such as what 'text' should contain or how icon/color/sound values are formatted.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly names the action ('Push'), the object ('notification'), and the destination ('AWTRIX display'), and adds the distinguishing 'instant, high-priority' quality. This makes it easy to separate from sibling tools that manage apps, settings, or device state.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit guidance on when to use this tool versus alternatives such as awtrix_test_render or awtrix_upsert_app. The phrase 'instant, high-priority' weakly implies a use case, but the agent has to infer the right context from the tool name and siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
awtrix_set_settingsAIdempotent
Configure display brightness, transition animations, and screen power state.
| Name | Required | Description | Default |
|---|---|---|---|
| power | No | ||
| brightness | No | ||
| transitions | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the description is not required to restate safety behavior. The description adds a bit of context by listing what settings are affected, but it does not disclose side effects, persistence, or range constraints beyond the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, compact sentence that states the action and the key areas affected. It is front-loaded with the verb and wastes no words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple three-parameter settings tool with an output schema and safety-related annotations, the description is mostly sufficient. It could mention that all parameters are optional and independently updatable, but the schema already conveys that through defaults and nullability.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description bears the responsibility for explaining parameters. It only paraphrases the property names (brightness, transitions, power) without adding meaning about value ranges, units, null semantics, or the effect of each flag. The schema reveals defaults but little explanatory content.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Configure') and clearly identifies the resource (display settings) while naming the three configurable areas: brightness, transition animations, and screen power state. This distinguishes it from the sibling tools like awtrix_notify, awtrix_upsert_app, and awtrix_delete_app.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description makes the tool's purpose clear enough that an agent can infer when to use it: whenever display-level settings need to be changed. It does not explicitly state when not to use it or name alternatives, but the context is unambiguous given the sibling tool names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
awtrix_test_renderARead-onlyIdempotent
Validate and preview a rendered notification/app payload with no hardware side-effects.
| Name | Required | Description | Default |
|---|---|---|---|
| hold | No | ||
| icon | No | ||
| kind | No | app | |
| text | Yes | ||
| color | No | ||
| rtttl | No | ||
| sound | No | ||
| wakeup | No | ||
| rainbow | No | ||
| duration | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include readOnlyHint=true and idempotentHint=true, lowering the burden on the description. The description adds useful specificity by stating 'no hardware side-effects', clarifying what read-only means in this hardware context. It does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single focused sentence with the action front-loaded and the key safety qualifier stated immediately. Every word earns its place; there is no repetition, filler, or structural waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With annotations covering safety, an output schema covering return shape, and schema defaults for optional parameters, the description is just barely viable for a minimal call using only the required `text` parameter. However, it lacks guidance on the notification/app distinction and advanced fields, and relies heavily on the provided schema and the agent's domain inference.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, yet the description provides essentially no parameter-level guidance. It only echoes the 'notification/app payload' concept, which maps to the `kind` enum, but gives no help on ten other parameters, including TextSegment, rtttl, wakeup, rainbow, and color. The description fails to compensate for the missing schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action, 'Validate and preview', applied to a defined resource, 'rendered notification/app payload'. It also distinguishes itself from hardware-affecting siblings by explicitly noting 'no hardware side-effects', leaving no ambiguity about what the tool is for.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context that this is a safe preview/validation operation, implying it should be used instead of side-effecting tools like awtrix_notify when testing payloads. It does not explicitly name alternatives or exclusion conditions, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
awtrix_upsert_appAIdempotent
Create or update a persistent custom app in the display carousel.
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | ||
| name | Yes | ||
| save | No | ||
| text | Yes | ||
| color | No | ||
| repeat | No | ||
| rainbow | No | ||
| duration | No | ||
| lifetime | No | ||
| lifetime_mode | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations provide idempotentHint and destructiveHint=false, and the description aligns by saying 'create or update' and 'persistent'. It adds useful context about the app living in the display carousel and being persistent, but it does not disclose nuances like the effect of the 'save', 'lifetime', or 'lifetime_mode' parameters on persistence, or whether updating an existing app overwrites prior configuration. No contradiction with annotations exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence with no wasted words. It is front-loaded with the operation ('Create or update') and immediately clarifies the resource and location ('persistent custom app in the display carousel').
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having an output schema (so return values need not be explained), the high parameter count, nested TextSegment definition, and zero parameter descriptions make the overall description insufficient. An agent would not know how to construct a valid 'text' payload, when 'save' should be true, or what lifetime/lifetime_mode mean, so the tool cannot be reliably invoked correctly from the description alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 10 parameters and 0% description coverage, so the description must compensate by explaining parameter meaning. It does not mention a single parameter (name, text, icon, save, color, repeat, rainbow, duration, lifetime, lifetime_mode), leaving the agent to rely solely on schema titles and defaults. This is insufficient for a schema of this complexity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The descrip states a specific verb ('Create or update' — an upsert) and a specific resource ('persistent custom app' in the 'display carousel'). This clearly distinguishes it from siblings such as awtrix_delete_app, awtrix_notify, and awtrix_set_settings because it targets custom app lifecycle management, not deletion, notification, or settings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly conveys when to use this tool: when the goal is to create or update a persistent custom app in the carousel. It does not explicitly name alternatives or state exclusions, but the context is strong enough that an agent can infer the intended use versus notify or delete siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
6 tool updates
v0.1.0- First observed
awtrix_delete_app - First observed
awtrix_get_device_state - First observed
awtrix_notify - First observed
awtrix_set_settings - First observed
awtrix_test_render - First observed
awtrix_upsert_app
TDQS
Scored across 6 tools
Each tool targets a distinct operation: app mutation, instant notification, device state query, settings, and safe preview. notify and test_render are clearly separated by side effects, while upsert_app vs notify is distinguished by persistence and priority.
All tools share the awtrix_ prefix and use snake_case with a mostly verb_noun pattern. awtrix_notify is a minor outlier because it lacks an explicit object, but the overall naming is still predictable and readable.
Six tools cover a focused display-management scope without redundancy. The count is well within the ideal range, and each tool serves a meaningful purpose.
The set covers app create/update/delete, notifications, settings, device state, and safe payload testing. Missing explicit list/get app endpoints are minor gaps that agents can partially work around using the existing app and state tools.
Maintenance
Related MCP Connectors
Run your TRMNL ePaper (e-ink) displays from any AI agent: devices, playlists and new screens.
A real clock for AI agents: current time, timezone conversion, and DST facts from the IANA tzdb.
Display delivery platform for AI agents. Push HTML, dashboards and live data to screens.
Persistent memory and knowledge management for AI agents with semantic search and 50+ tools.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI agents to control and monitor Home Assistant smart home devices through natural language interactions. Supports device control, entity state monitoring, history access, and automation generation with both MCP protocol and standalone HTTP REST API modes.1MIT
- AlicenseAqualityAmaintenanceEnables programmatic control of Divoom Pixoo LED matrices to display layered pixel art, animations, and hardware-rendered scrolling text. Users can compose complex visual scenes, push images, and manage device settings like brightness and channels through an LLM.8238 npm10Apache 2.0
- AlicenseAqualityDmaintenanceEnables registration, monitoring, and control of IoT devices via AI agents, with local storage and no cloud API key required.9MIT
- AlicenseAqualityCmaintenanceMCP server and CLI for controlling Ulanzi TC001 Smart Pixel Clock via AWTRIX3 HTTP API. Enables power, brightness, notifications, and more from AI assistants.202MIT