World Monitor
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
MCP server for Yeastar P-Series PBX System API (read-only).
Lists are ordered by a usage score (out of 100) built from these parts
| Popularity | 6/80 | GitHub stars or weekly downloads: the larger counts 60, the smaller 20 |
|---|---|---|
| Freshness | 12/12 | Full marks for a release or code change within 30 days |
| Still answering | 0/8 | The cloud endpoint answered at the last check |
| Usage score | 18/100 |
Quality: Passed 2/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)
Pick the AI app you use, then copy the settings.
Let your AI install it with one sentence
Please install Yeastar P-Series PBX. Follow https://mcp.popnx.com/i/wyre-ai-yeastar-mcp.md, show me the commands and wait for my OK before running them.Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads
Passed 2/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026
First: which AI do you use?
Pick your app and the steps appear below.
Works with Claude, with some setup first
You need a Yeastar P-Series PBX key (create it on the maker’s site) · 1 setting(s) to fill in (YEASTAR_PBX_DOMAIN) · Install Docker on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server Yeastar P-Series PBX for Claude on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "yeastar": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "YEASTAR_PBX_DOMAIN", "-e", "YEASTAR_CLIENT_ID", "-e", "YEASTAR_CLIENT_SECRET", "-e", "AUTH_MODE", "ghcr.io/wyre-ai/yeastar-mcp:v1.0.2" ], "env": { "YEASTAR_PBX_DOMAIN": "your-value", "YEASTAR_CLIENT_ID": "your-value", "YEASTAR_CLIENT_SECRET": "your-value", "AUTH_MODE": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Yeastar P-Series PBX tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
YEASTAR_PBX_DOMAIN This appliance's own domain/IP and port, e.g. https://pbx.example.com:8088. Each customer's PBX is its own instance - there is no shared hosted endpoint.Descriptions are as written by the maker.
SettingsDeveloperEdit Config
{
"mcpServers": {
"yeastar": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"YEASTAR_PBX_DOMAIN",
"-e",
"YEASTAR_CLIENT_ID",
"-e",
"YEASTAR_CLIENT_SECRET",
"-e",
"AUTH_MODE",
"ghcr.io/wyre-ai/yeastar-mcp:v1.0.2"
],
"env": {
"YEASTAR_PBX_DOMAIN": "your-value",
"YEASTAR_CLIENT_ID": "your-value",
"YEASTAR_CLIENT_SECRET": "your-value",
"AUTH_MODE": "your-value"
}
}
}
}Paste the key only into the app’s field, never into a chat or to anyone
Use Yeastar P-Series PBX and tell me what you can do for me, then show me one thing✓ If Claude says it is using Yeastar P-Series PBX or shows a Yeastar P-Series PBX tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
MCP_TRANSPORT Transport mode for the server. Set to 'stdio' for local CLI use; the image defaults to 'http' for gateway hosting. · default stdioLOG_LEVEL Log verbosity: debug, info, warn, error · default infoDescriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
ChatGPT cannot connect Yeastar P-Series PBX yet
Yeastar P-Series PBX runs on your computer, but ChatGPT can only connect servers that run on the web
A · Use an app that can connect Yeastar P-Series PBX
B · Others in Other that work with ChatGPT
Picked from the most used in the same category, only ones that connect by address with no key
Works with Claude Code, with some setup first
You need a Yeastar P-Series PBX key (create it on the maker’s site) · 1 setting(s) to fill in (YEASTAR_PBX_DOMAIN) · Install Docker on your computer first (one time)
Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server Yeastar P-Series PBX for Claude Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user yeastar --env YEASTAR_PBX_DOMAIN=your-value --env YEASTAR_CLIENT_ID=your-value --env YEASTAR_CLIENT_SECRET=your-value --env AUTH_MODE=your-value -- docker run -i --rm -e YEASTAR_PBX_DOMAIN -e YEASTAR_CLIENT_ID -e YEASTAR_CLIENT_SECRET -e AUTH_MODE ghcr.io/wyre-ai/yeastar-mcp:v1.0.2 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Yeastar P-Series PBX tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
YEASTAR_PBX_DOMAIN This appliance's own domain/IP and port, e.g. https://pbx.example.com:8088. Each customer's PBX is its own instance - there is no shared hosted endpoint.Descriptions are as written by the maker.
Mac: press Command+Space and type Terminal · Windows: open PowerShell
claude mcp add --scope user yeastar --env YEASTAR_PBX_DOMAIN=your-value --env YEASTAR_CLIENT_ID=your-value --env YEASTAR_CLIENT_SECRET=your-value --env AUTH_MODE=your-value -- docker run -i --rm -e YEASTAR_PBX_DOMAIN -e YEASTAR_CLIENT_ID -e YEASTAR_CLIENT_SECRET -e AUTH_MODE ghcr.io/wyre-ai/yeastar-mcp:v1.0.2Replace “your-value” with your key before pressing Enter
Paste the key only into the app’s field, never into a chat or to anyone
You should see Yeastar P-Series PBX listed as connected
Use Yeastar P-Series PBX and tell me what you can do for me, then show me one thing✓ If Claude Code says it is using Yeastar P-Series PBX or shows a Yeastar P-Series PBX tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
MCP_TRANSPORT Transport mode for the server. Set to 'stdio' for local CLI use; the image defaults to 'http' for gateway hosting. · default stdioLOG_LEVEL Log verbosity: debug, info, warn, error · default infoDescriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with Cursor, with some setup first
You need a Yeastar P-Series PBX key (create it on the maker’s site) · 1 setting(s) to fill in (YEASTAR_PBX_DOMAIN) · Install Docker on your computer first (one time)
Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server Yeastar P-Series PBX for Cursor on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "yeastar": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "YEASTAR_PBX_DOMAIN", "-e", "YEASTAR_CLIENT_ID", "-e", "YEASTAR_CLIENT_SECRET", "-e", "AUTH_MODE", "ghcr.io/wyre-ai/yeastar-mcp:v1.0.2" ], "env": { "YEASTAR_PBX_DOMAIN": "your-value", "YEASTAR_CLIENT_ID": "your-value", "YEASTAR_CLIENT_SECRET": "your-value", "AUTH_MODE": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Yeastar P-Series PBX tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
YEASTAR_PBX_DOMAIN This appliance's own domain/IP and port, e.g. https://pbx.example.com:8088. Each customer's PBX is its own instance - there is no shared hosted endpoint.Descriptions are as written by the maker.
In the Yeastar P-Series PBX settings, YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN is empty; add your key and save
Paste the key only into the app’s field, never into a chat or to anyone
Use Yeastar P-Series PBX and tell me what you can do for me, then show me one thing✓ If Cursor says it is using Yeastar P-Series PBX or shows a Yeastar P-Series PBX tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
MCP_TRANSPORT Transport mode for the server. Set to 'stdio' for local CLI use; the image defaults to 'http' for gateway hosting. · default stdioLOG_LEVEL Log verbosity: debug, info, warn, error · default infoDescriptions are as written by the maker.
Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with VS Code, with some setup first
You need a Yeastar P-Series PBX key (create it on the maker’s site) · 1 setting(s) to fill in (YEASTAR_PBX_DOMAIN) · Install Docker on your computer first (one time)
Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server Yeastar P-Series PBX for VS Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "yeastar": { "type": "stdio", "command": "docker", "args": [ "run", "-i", "--rm", "-e", "YEASTAR_PBX_DOMAIN", "-e", "YEASTAR_CLIENT_ID", "-e", "YEASTAR_CLIENT_SECRET", "-e", "AUTH_MODE", "ghcr.io/wyre-ai/yeastar-mcp:v1.0.2" ], "env": { "YEASTAR_PBX_DOMAIN": "your-value", "YEASTAR_CLIENT_ID": "your-value", "YEASTAR_CLIENT_SECRET": "your-value", "AUTH_MODE": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Yeastar P-Series PBX tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
YEASTAR_PBX_DOMAIN This appliance's own domain/IP and port, e.g. https://pbx.example.com:8088. Each customer's PBX is its own instance - there is no shared hosted endpoint.Descriptions are as written by the maker.
In the Yeastar P-Series PBX settings, YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE, YEASTAR_PBX_DOMAIN is empty; add your key and save
Paste the key only into the app’s field, never into a chat or to anyone
Use Yeastar P-Series PBX and tell me what you can do for me, then show me one thing✓ If VS Code says it is using Yeastar P-Series PBX or shows a Yeastar P-Series PBX tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
MCP_TRANSPORT Transport mode for the server. Set to 'stdio' for local CLI use; the image defaults to 'http' for gateway hosting. · default stdioLOG_LEVEL Log verbosity: debug, info, warn, error · default infoDescriptions are as written by the maker.
Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.
JSON settings are under “For developers” below
Claude Code
claude mcp add --scope user yeastar --env YEASTAR_PBX_DOMAIN=your-value --env YEASTAR_CLIENT_ID=your-value --env YEASTAR_CLIENT_SECRET=your-value --env AUTH_MODE=your-value -- docker run -i --rm -e YEASTAR_PBX_DOMAIN -e YEASTAR_CLIENT_ID -e YEASTAR_CLIENT_SECRET -e AUTH_MODE ghcr.io/wyre-ai/yeastar-mcp:v1.0.2Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"yeastar": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"YEASTAR_PBX_DOMAIN",
"-e",
"YEASTAR_CLIENT_ID",
"-e",
"YEASTAR_CLIENT_SECRET",
"-e",
"AUTH_MODE",
"ghcr.io/wyre-ai/yeastar-mcp:v1.0.2"
],
"env": {
"YEASTAR_PBX_DOMAIN": "your-value",
"YEASTAR_CLIENT_ID": "your-value",
"YEASTAR_CLIENT_SECRET": "your-value",
"AUTH_MODE": "your-value"
}
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"yeastar": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"YEASTAR_PBX_DOMAIN",
"-e",
"YEASTAR_CLIENT_ID",
"-e",
"YEASTAR_CLIENT_SECRET",
"-e",
"AUTH_MODE",
"ghcr.io/wyre-ai/yeastar-mcp:v1.0.2"
],
"env": {
"YEASTAR_PBX_DOMAIN": "your-value",
"YEASTAR_CLIENT_ID": "your-value",
"YEASTAR_CLIENT_SECRET": "your-value",
"AUTH_MODE": "your-value"
}
}
}
}VS Code (mcp.json)
{
"servers": {
"yeastar": {
"type": "stdio",
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"YEASTAR_PBX_DOMAIN",
"-e",
"YEASTAR_CLIENT_ID",
"-e",
"YEASTAR_CLIENT_SECRET",
"-e",
"AUTH_MODE",
"ghcr.io/wyre-ai/yeastar-mcp:v1.0.2"
],
"env": {
"YEASTAR_PBX_DOMAIN": "your-value",
"YEASTAR_CLIENT_ID": "your-value",
"YEASTAR_CLIENT_SECRET": "your-value",
"AUTH_MODE": "your-value"
}
}
}
}YEASTAR_PBX_DOMAIN required envYEASTAR_CLIENT_ID secret required envYEASTAR_CLIENT_SECRET secret required envMCP_TRANSPORT envAUTH_MODE secret required envLOG_LEVEL envDescriptions are as written by the maker.
These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.
Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.
Run on your computer in
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
Runs on your computer; the tool list appears in your AI app after you install it.
We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 19, 2026
The registry name was verified with the GitHub account WYRE-AI, which owns the repo
Code last changed 7 days ago
GitHub could not identify the licence type; open the file to check
This one runs on your computer; there is no internet endpoint
Runs on your computer and uses local settings instead
Runs on your computer; we can only read tool lists from internet endpoints
Not checked: only npm and PyPI packages with a version can be checked
If you made this, paste this code into your README. The badge links back to this page.
[](https://mcp.popnx.com/en/servers/wyre-ai-yeastar-mcp)Ask, share a tip or report that it does not work. Sorted by what people marked helpful.
No posts yet. Be the first to ask or share.
Posts here are written by users, not the PopNx team.
No reviews yet
Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.
It passed 2 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.
You need to fill in: YEASTAR_CLIENT_ID, YEASTAR_CLIENT_SECRET, AUTH_MODE
It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).
The GitHub repo last changed 7 days ago, and the latest version (1.0.2) reached the registry 28 days ago.
Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Docker on your computer.
In the same category: World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu
Same category, other makers, commands already checked. Official ones first, then by stars.
Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
Manage monitors, status pages, incidents and maintenances in your openstatus workspace.
Validate oh-my-posh configurations and segment snippets against the official schema.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
Manage Jitsu data pipelines: destinations, streams, connections, functions, live events.
| This one Yeastar P-Series PBX | World Monitor | openstatus | Oh My Posh Validator | Strata | Jitsu | |
|---|---|---|---|---|---|---|
| Runs where | Installs on your computer | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install |
| Needs a key | Yes | No | No | No | No | No |
| Add with + in Claude | No | No | No | No | No | No |
| Basic checks | 2/3 | 4/4 | 4/4 | 4/4 | 1/4 | 4/4 |
| License | NOASSERTION | AGPL-3.0 | AGPL-3.0 | MIT | Apache-2.0 | MIT |
| Price | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry |
Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.
MCP server for the Yeastar P-Series PBX System OpenAPI - read-only visibility into extensions, extension groups, trunks, inbound/outbound routes, IVR menus, ring groups, queues (including live call/agent status), the company contact directory, call detail records (CDR), call reports, backup metadata, and certificate metadata, for AI assistants and the WYRE Conduit gateway.
This connector targets the P-Series Appliance Edition's OpenAPI, base path `openapi/v1.0`. Per Yeastar's own developer docs (help.yeastar.com, "P-Series Appliance Edition Developer Guide"), the API is only supported on:
Cloud Edition is a separate product with its own developer guide and its own OpenAPI surface (same openapi/v1.0 base path structure, firmware requirement documented as 84.7.0.17+), which this connector's request/response shapes were not independently verified against - Appliance and Cloud Edition guides diverge in places (e.g. Cloud Edition additionally documents a v2.0 CDR surface not covered here). If a customer runs Cloud Edition, treat this connector as unverified, not confirmed-incompatible - most of the base OpenAPI mechanics (token exchange, response envelope, pagination) are described identically in both guides, but no endpoint here has been tested against a live Cloud Edition instance.
Software Edition (self-hosted, non-appliance) and any other P-Series variant are out of scope - not mentioned in the Appliance Edition API-support statement above, and not evaluated for this connector.
If a customer's actual hardware/edition is unknown, verify against the PBX web portal (Settings -> About, or the model shown in yeastar_get_system_information) before assuming this connector will work - a PBX outside P550/P560/P570 (Appliance) or Cloud Edition will very likely reject get_token outright with the API feature toggle unavailable in its portal at all.
Each Yeastar P-Series PBX is its own appliance, with its own domain/IP and its own credentials - there is no shared hosted API endpoint. A customer enables the API themselves in their PBX's web portal (Integrations -> API, toggle "API" on) and generates a Client ID and Client Secret there. This is not a browser-based OAuth consent flow - the customer pastes the resulting Client ID/Secret directly into the connect form, the same shape as this fleet's other self-hosted/BYO-instance connectors (e.g. Hudu, IT Glue), not the shared-app Authorization Code flow used for SaaS vendors like Cork.
This connector exchanges the Client ID/Secret for a short-lived access token itself - it never proxies them directly into a PBX request. Per Yeastar's docs (POST /openapi/v1.0/get_token), the wire format is genuinely {"username": " ", "password": " "} - Yeastar's own docs are explicit that these fields *are* the Client ID/Secret ("obtain the username from the Client ID on PBX web portal"), not a separate credential; this connector preserves that field naming rather than renaming it, since it's what the vendor's API actually expects on the wire.
Token lifetime and caching. Access tokens expire after 30 minutes; refresh tokens after 24 hours. Yeastar also caps each application to 8 simultaneous valid tokens. Because of that cap, this connector does not mint a fresh token on every tool call - src/client.ts caches the access token in memory, keyed by appliance + Client ID + Client Secret, and reuses it across calls until it's within 60 seconds of expiring. On a TOKEN EXPIRED response (errcode 10004), it transparently mints a fresh token and retries the failed call exactly once. This is a deliberate deviation from the pattern in this fleet's other connectors (which mint per-request or hold a single static key) - it exists because Yeastar's token model genuinely requires it, not as an optimization for its own sake: without caching, any session making more than 8 tool calls within a 30-minute window would start failing with MAX LIMITATION EXCEEDED (errcode 60002) from Yeastar itself.
In gateway mode, the three credential fields arrive per-request via X-Yeastar-Pbx-Domain / X-Yeastar-Client-Id / X-Yeastar-Client-Secret headers, injected by the Conduit gateway. A /mcp request missing any of those headers is rejected with 401 and does not fall back to YEASTAR_* in the process environment. In local/stdio mode, and in HTTP AUTH_MODE=env, they're read from YEASTAR_PBX_DOMAIN / YEASTAR_CLIENT_ID / YEASTAR_CLIENT_SECRET.
HTTP also requires service-to-service auth. With CONDUIT_S2S_SECRET set, every /mcp request must include X-Gateway-S2S. The header value is t= ,v1= . The MAC is HMAC-SHA256 over the ASCII message t= (the same t= prefix that appears in the header), keyed by CONDUIT_S2S_SECRET, and encoded as lowercase hex. The timestamp must be within 300 seconds of the server clock. A missing or invalid header returns 401 before vendor credentials are read. The secret is never written to logs. /health and /healthz stay unauthenticated and do not read credentials. The stdio transport does not use CONDUIT_S2S_SECRET.
X-Gateway-S2S check passes (and, in gateway mode, the X-Yeastar-* credential headers are present), a Content-Length above the cap returns 413 with a JSON-RPC error; bodies without Content-Length are capped by the MCP SDK transport. Unauthenticated requests still get 401 first.tools/call arguments are capped at 10,000 elements (every array item and object key at any depth). Larger inputs return a fixed isError tool result ("Tool input exceeds the maximum of 10000 elements") that does not echo the tool name, and are never dispatched.These limits address CVE-2026-111768 / GHSA-46jr-4wx8-v453 (memory exhaustion during validation) and GHSA-f897-62hf-6gxq (no request body / batch cap).
Every request also passes a mandatory `User-Agent: OpenAPI` header - Yeastar's API rejects requests missing it (errcode 40002, "PARAMETER ERROR").
Defensive field-stripping. Trunk configuration commonly carries SIP registration secrets (auth/register passwords) inline in the same object a read returns, and Yeastar's schema for these objects isn't machine-verifiable from the docs alone. Every response from every tool in this connector - not just trunk tools - passes through stripSecretFields() before it ever reaches the model: any object key matching /secret|password|pwd/i, at any depth, is dropped. This is a blanket safety net on top of, not instead of, the endpoint-level exclusions below (extension/getpassword and conference/viewpassword are never called at all).
Structurally verified (this codebase): this connector's src/client.ts implements exactly one HTTP verb function, doGet - there is no doPost/doPut/doDelete anywhere in this codebase, so it is *incapable* of issuing a write/control/delete request to the PBX regardless of what the credential itself is permitted to do. src/__tests__/tool-scope.test.ts pins the exact 26-tool set and asserts no tool name matches a write/control/credential-exposing token list.
Vendor-documented, not independently verified: whether the PBX's own admin portal offers any way to scope a Client ID/Secret pair to read-only access is not documented. Per help.yeastar.com's "Enable Yeastar P-Series PBX API" page, enabling the API surfaces exactly one toggle ("API" on/off) plus an optional IP-restriction allowlist and status-monitor configuration - no permission-group, role, or scope selection is described anywhere in that flow. This differs from e.g. Cisco Duo (cisco-duo-mcp), where the vendor's own admin panel offers explicit Grant Read Resource / Grant Write Resource toggles per integration. The practical implication: a Client ID/Secret pair generated for this connector is, as far as Yeastar's own documentation shows, capable of the PBX's full write/control API even though this connector's code never exercises that capability. The only vendor-side compensating control documented is the optional IP-restriction allowlist (scope the credential to only be usable from Conduit's egress IP(s)) - recommend enabling it. If a narrower credential-scoping mechanism does exist and simply isn't documented publicly, it wasn't found during this connector's build and should be treated as unconfirmed.
| Env var | Description | |||
|---|---|---|---|---|
YEASTAR_PBX_DOMAIN | This appliance's own domain/IP and port, e.g. https://pbx.example.com:8088 (default OpenAPI port is 8088). A bare host with no scheme is treated as https. | |||
YEASTAR_CLIENT_ID | OAuth-style Client ID, generated in the PBX web portal under Integrations -> API. | |||
YEASTAR_CLIENT_SECRET | OAuth-style Client Secret, generated in the same place. | |||
MCP_TRANSPORT | stdio (default) or http. | |||
AUTH_MODE | env (default, reads the vars above) or gateway (credentials arrive per-request via X-Yeastar-Pbx-Domain/X-Yeastar-Client-Id/X-Yeastar-Client-Secret). Gateway mode returns 401 when any of those headers is missing and never falls back to YEASTAR_*. The container image and Compose default to gateway. | |||
CONDUIT_S2S_SECRET | Required to start the HTTP transport. The process logs an error and exits non-zero when this is empty or a known placeholder (changeme, secret, replace-me, your-s2s-secret, and the other public example values). Compose will not start when it is unset. Never commit a real value. | |||
MCP_ALLOW_INSECURE_DEV | Set to exactly 1 only for local development to start HTTP without CONDUIT_S2S_SECRET. The process logs a warning, does not enforce X-Gateway-S2S, and binds 127.0.0.1 only. A non-loopback MCP_HTTP_HOST (including 0.0.0.0) refuses to start. A known placeholder secret still refuses to start when this flag is set. | |||
MCP_HTTP_HOST | Bind address when a real CONDUIT_S2S_SECRET is set. Unset keeps the historical 0.0.0.0 bind. The container image and Compose set 0.0.0.0 inside the container and publish the host port on 127.0.0.1. Without a secret, the insecure-dev bypass listens on 127.0.0.1 only and refuses a non-loopback value. | |||
MCP_HTTP_PORT | HTTP port. Defaults to 8080. | |||
LOG_LEVEL | debug \ | info (default) \ | warn \ | error. |
All 26 tools are read-only. yeastar_get_trunk is additionally classified sensitive in Conduit's VENDOR_TOOL_CONFIG given trunk config's proximity to telephony secrets, even after field-stripping.
yeastar_get_system_information - this appliance's model, firmware version, hostname.yeastar_get_system_capacity - current usage against licensed extension/trunk/concurrent-call capacity.yeastar_list_extensions - list extensions with basic info and per-device online/presence status.yeastar_get_extension - full detail for a single extension (never includes its password).yeastar_list_extension_groups - list extension groups.yeastar_get_extension_group - full detail (member extensions) for one group.yeastar_list_trunks - list configured trunks.yeastar_get_trunk - full detail for a single trunk, with secret-shaped f