yeastar-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| MCP_TLS_KEY | No | Optional path to the TLS private key for direct HTTPS. | |
| CONFIRM_MODE | No | Change confirmation mode: auto (default), elicit (mandatory MCP elicitation form), or chat (confirmation only in chat through the assistant). | auto |
| MCP_TLS_CERT | No | Optional path to the TLS certificate for direct HTTPS. | |
| MCP_TRANSPORT | No | Transport mode. Set to stdio for local use where the client and server run on the same machine; in this mode no token is needed. | |
| MCP_AUTH_TOKEN | No | Bearer token required for HTTP transport, at least 24 characters. Not needed when MCP_TRANSPORT=stdio. | |
| MCP_ALLOWED_IPS | No | Optional IP allowlist for incoming connections. | |
| YEASTAR_BASE_URL | No | Base URL of the Yeastar PBX OpenAPI (openapi/v1.0). | |
| MCP_ALLOWED_HOSTS | No | Optional allowed hosts list for DNS rebinding protection. | |
| YEASTAR_CLIENT_ID | No | Yeastar API Client ID, obtained from the PBX under Integrations → API. | |
| YEASTAR_READ_ONLY | No | Set to true to run the server in read-only mode. | |
| CHANGE_TTL_SECONDS | No | Lifetime of prepared change previews in seconds. Defaults to 15 minutes. | 900 |
| YEASTAR_ALLOW_SECRETS | No | Set to true to re-enable endpoints that return passwords/PINs in clear text; blocked by default. | |
| YEASTAR_CLIENT_SECRET | No | Yeastar API Client Secret, obtained from the PBX under Integrations → API. | |
| YEASTAR_ALLOW_CALL_MONITORING | No | Set to true to re-enable call listening and recording endpoints; blocked by default. |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
Server MCP per amministrare un centralino Yeastar P-Series Software Edition nella LAN.
LETTURA: yeastar_overview, yeastar_catalog, yeastar_list, yeastar_search, yeastar_get, yeastar_query, yeastar_read (qualsiasi endpoint di sola lettura, es. CDR, stato code, chiamate attive).
MODIFICHE - SEMPRE IN DUE FASI:
yeastar_prepare_change / yeastar_prepare_operation / yeastar_prepare_raw / yeastar_prepare_rollback NON modificano nulla: restituiscono un'anteprima (diff prima/dopo) e un change_id.
Mostra l'anteprima all'utente con parole chiare e ASPETTA una conferma esplicita. Solo dopo un "sì" riferito a quella specifica anteprima chiama yeastar_apply_change(change_id, confirm=true). Non chiamare mai yeastar_apply_change nello stesso turno in cui hai preparato la modifica, a meno che l'utente non abbia già approvato esattamente quella modifica. Se l'utente cambia idea usa yeastar_cancel_change. Per modifiche importanti proponi prima un backup (yeastar_prepare_change resource="backup" action="create").
Gli ID: ogni oggetto ha un 'id' univoco diverso dal numero (es. interno 2000 può avere id 39). Trova l'id con yeastar_search. Per gli update invia SOLO i campi da cambiare. I valori sensibili (password, PIN) appaiono come '***'.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| yeastar_overviewA | Informazioni generali sul centralino: modello, versione firmware, capacità (interni, chiamate contemporanee) e stato del server MCP. Usalo come primo controllo della connessione. |
| yeastar_catalogA | Elenco delle risorse configurabili (con i verbi disponibili) e delle operazioni live (riavvio telefoni, pausa agenti, chiamate, conferenze) supportate da questo server. |
| yeastar_listA | Elenca gli oggetti di una risorsa (paginato). Restituisce i dati base; per il dettaglio usa yeastar_get. |
| yeastar_searchA | Cerca oggetti per numero o nome. Serve anche a trovare l'id da usare in get/update/delete. |
| yeastar_getB | Configurazione completa di un oggetto (o di un'impostazione globale). |
| yeastar_queryC | Configurazione completa di più oggetti in una sola chiamata. |
| yeastar_readA | Chiama qualsiasi endpoint di SOLA LETTURA dell'API Yeastar (GET). Utile per CDR, report, stato live di code/chiamate/conferenze, registrazioni, log, opzioni dei menu. Rifiuta gli endpoint che modificano qualcosa: per quelli usa yeastar_prepare_raw. |
| yeastar_prepare_changeA | PREPARA (non applica) una modifica di configurazione. Legge lo stato attuale, calcola il diff prima/dopo e restituisce un change_id. Mostra l'anteprima all'utente e aspetta il suo sì prima di chiamare yeastar_apply_change. |
| yeastar_prepare_operationA | PREPARA (non esegue) un'operazione live: riavvio/riprovisioning/modifica batch dei telefoni, login/pausa agenti, gestione conferenze, controllo chiamate. Restituisce un change_id da confermare. |
| yeastar_prepare_rawA | PREPARA una chiamata diretta a un endpoint non coperto dal catalogo (escape hatch). Nessun diff automatico: usa solo se le altre funzioni non bastano. Va confermata con yeastar_apply_change. |
| yeastar_prepare_rollbackA | PREPARA l'annullamento di una modifica già applicata, usando lo snapshot salvato: ripristina i valori precedenti (update), elimina l'oggetto creato (create) o lo ricrea (delete). |
| yeastar_apply_changeA | APPLICA al centralino una modifica preparata. Da chiamare SOLO dopo che l'utente ha visto l'anteprima e ha risposto esplicitamente di sì. Se il client lo supporta, il server chiede anche una conferma diretta all'utente (modulo Sì/No) che l'assistente non può compilare al posto suo. Controlla che la configurazione non sia cambiata, salva uno snapshot, esegue, rilegge e verifica, scrive nel registro. |
| yeastar_cancel_changeB | Scarta una modifica preparata e non ancora applicata. |
| yeastar_pending_changesA | Elenca le modifiche preparate in attesa di conferma (scadono dopo CHANGE_TTL_SECONDS). |
| yeastar_audit_logB | Registro delle modifiche applicate (o fallite) tramite questo server, dalla più recente. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 15 tools
Most tools have clearly distinct roles: list/search/get/query separate basic listing, lookup, single-detail, and batch-detail reads, while prepare_change, prepare_operation, prepare_raw, and prepare_rollback are differentiated by config changes, live operations, raw escape hatch, and rollback. Some overlap remains between yeastar_read and the catalog-based read tools, since read can also retrieve status/report data that overlaps conceptually with get/query/list.
All tools use a consistent yeastar_ snake_case prefix, and the core workflow names (prepare_change, apply_change, cancel_change, pending_changes, audit_log) are highly predictable. Minor inconsistency comes from mixing verb-style names (list, search, get, query, read) with noun-style names (overview, catalog, audit_log), though the pattern remains readable.
Fifteen tools is at the upper end of the ideal range but appropriate for a PBX management server that separates read operations, safe preparation, application, cancellation, rollback, and auditing. Each tool appears to serve a distinct part of the configuration/live-operation lifecycle rather than duplicating another.
The server covers discovery (overview, catalog), read workflows (list, search, get, query, read), safe write workflows (prepare/apply/cancel/pending), rollback, raw endpoint escape, and audit logging. This provides broad CRUD/lifecycle coverage for PBX configuration and live operations with no obvious dead ends, especially because generic read and raw/prepare paths cover uncatalogued endpoints.