Tailscale MCP

io.github.TMHSDigital由 GitHub 帳號 TMHSDigital 發布v0.4.0更新於 Nov 2, 2026

Let AI agents see and use your tailnet: status, SSH config, Serve/Funnel sharing, ping matrix

概覽

AI 產生的概覽

讓助理檢視本機 Tailscale 網路狀態、產生 SSH 設定、透過 Serve/Funnel 分享本機連接埠,並量測節點延遲。

可以做什麼
  • 讀取 tailnet 狀態:本節點與所有對等節點的 MagicDNS 名稱、IP、作業系統、上線狀態、出口節點標記與標籤
  • 為 tailnet 節點產生 ssh-config Host 區塊,可僅預覽,或寫入專用檔案、寫入使用者 SSH 設定中的受管區塊
  • 檢視、建立與停止本機連接埠的 Serve/Funnel 分享,並標示每個端點是否公開
  • 同時 ping 對等節點,回傳延遲矩陣,標明直連、DERP 中繼或節點中繼路徑
適用情境
適合助理需要操作 Tailscale 網路的情境:以 MagicDNS 名稱而非寫死的 IP 找到節點、為 tailnet 機器準備 SSH 存取、暫時把本機開發連接埠分享給 tailnet 夥伴,或在大量傳輸前確認路徑是直連還是中繼。
執行需求
以 stdio 方式在本機透過 npx 執行,需要 Node 22+ 以及已安裝並已登入的 Tailscale 用戶端。tailscale 執行檔會從 PATH 或預設安裝位置尋找,也可用 TAILSCALE_MCP_BIN 指定。選用設定:TAILSCALE_MCP_READONLY、TAILSCALE_MCP_ALLOW_FUNNEL、TAILSCALE_MCP_TIMEOUT_MS。在 Linux 上變更 Serve/Funnel 需要 root 或已設定的 operator。
安裝前請注意
share_port 傳 public=true 會使用 Funnel 把連接埠暴露到公開網際網路;未設定 TAILSCALE_MCP_ALLOW_FUNNEL 時會被拒絕。stop_share 傳 all=true 會清空整個 serve/funnel 設定,包括不是此伺服器建立的分享。generate_ssh_config 傳 write=true 會修改 SSH 設定檔(會保留備份)。伺服器透過呼叫 tailscale 命令列運作,不處理驗證金鑰或其他憑證。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Tailscale MCP,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

Tailscale MCP

MCP server for safe programmatic access to the local Tailscale daemon: tailnet discovery, SSH config generation, port sharing via Serve/Funnel, and latency matrices.

[License: CC-BY-NC-ND-4.0] [npm version] [CI]


Gives agents and developer tools a safe, structured window into the local Tailscale daemon over stdio. It shells out to the tailscale CLI (resolved from PATH, with fallbacks to the default install locations on Windows and macOS) and never handles auth keys or tailnet credentials: the CLI talks to the already-authenticated local daemon.

When the binary is missing, the daemon is stopped, or the device needs login, every tool returns a structured error with a code and the exact remedy command instead of throwing.

Installation

[Add to Cursor] [Install in VS Code] [Download for Claude Desktop]

  • Claude Code: claude mcp add tailscale -- npx -y @tmhs/tailscale-mcp
  • Claude Desktop: download tailscale-mcp.mcpb from the latest release and open it. The install dialog has switches for read-only mode and Funnel.
  • Cursor / VS Code: use the buttons above.
  • MCP Registry: listed in the official MCP Registry as io.github.TMHSDigital/tailscale-mcp, so registry-aware clients and catalogs can find it.

Or add it to any MCP client's configuration by hand:

json
{  "mcpServers": {    "tailscale": {      "command": "npx",      "args": ["-y", "@tmhs/tailscale-mcp"]    }  }}

Requires Node 22+ (an active LTS) and an installed, logged-in Tailscale client.

Finding the tailscale CLI

The server looks for tailscale on PATH, then in the platform's default install locations: C:\Program Files\Tailscale\tailscale.exe on Windows, and /Applications/Tailscale.app/Contents/MacOS/Tailscale, /opt/homebrew/bin/tailscale, and /usr/local/bin/tailscale on macOS. Mac App Store installs therefore work without extra setup. To use a different binary, set TAILSCALE_MCP_BIN:

json
{  "mcpServers": {    "tailscale": {      "command": "npx",      "args": ["-y", "@tmhs/tailscale-mcp"],      "env": { "TAILSCALE_MCP_BIN": "/path/to/tailscale" }    }  }}

Timeouts

Every tailscale invocation is bounded, by default to 10 seconds. A hung daemon returns a structured TIMEOUT error instead of stalling the agent. Set TAILSCALE_MCP_TIMEOUT_MS to raise the limit for slow machines or very large tailnets. share_port waits up to 15 seconds and ping scales with count and timeoutMs; ping_all as a whole is capped at 45 seconds.

Configuration reference

All settings are environment variables in the server's env block. Boolean flags accept 1/true/yes/on or 0/false/no/off. Any other value stops the server at startup, so a typo can never silently loosen a safety setting.

VariableDefaultEffect
TAILSCALE_MCP_ALLOW_FUNNELoffAllows share_port {"public": true}, which exposes a port to the open internet via Funnel. While off, the call returns FUNNEL_DISABLED and nothing is shared.
TAILSCALE_MCP_READONLYoffMonitoring-only mode: share_port and stop_share are not registered, and generate_ssh_config refuses write: true (READ_ONLY).
TAILSCALE_MCP_BIN(search)Path to the tailscale binary.
TAILSCALE_MCP_TIMEOUT_MS10000Per-call CLI timeout.

Linux: Serve/Funnel permissions

On Linux only root or the configured operator can change Serve/Funnel settings. If share_port or stop_share returns PERMISSION_DENIED, allow your user once:

bash
sudo tailscale set --operator=$USER

Tools

Every tool declares MCP annotations, so clients can auto-approve the read-only ones and confirm the rest. Results come back as structuredContent, typed by each tool's outputSchema, with the same JSON repeated in a text block for older clients. The full definitions are in mcp-tools.json, which is generated from the server.

ToolRead-onlyDestructiveIdempotentOpen world
tailnet_statusyesnoyesno
share_statusyesnoyesno
ping_allyesnoyesno
generate_ssh_configno (writes only with write: true)noyesno
share_portnonoyesonly when Funnel is allowed
stop_sharenoyesyesno

tailnet_status

Trimmed view of tailscale status --json: self node plus peers with hostname, MagicDNS name, Tailscale IPv4/IPv6, OS, online flag, last seen, exit-node flags, and tags. Input: optional onlineOnly.

json
{  "backendState": "Running",  "tailnet": "[email protected]",  "magicDNSSuffix": "tail1234.ts.net",  "self": {"hostname": "DEVPC", "dnsName": "devpc.tail1234.ts.net", "ipv4": "100.101.1.10"},  "peerCount": 3,  "peers": [    {"hostname": "raspi", "dnsName": "raspi.tail1234.ts.net", "ipv4": "100.101.1.20", "os": "linux", "online": true, "exitNodeOption": true, "tags": []}  ]}

generate_ssh_config

Emits ssh-config Host blocks for tailnet nodes (MagicDNS name preferred, Tailscale IP fallback). Dry-run by default: returns the generated text only. Inputs: write, target, onlineOnly, includeShared, user.

  • Each Host alias is the node's first MagicDNS label (raspi.tail1234.ts.net → raspi), falling back to a sanitized OS hostname ([a-z0-9-] only). Colliding aliases get a numeric suffix and are listed under renamed. Mullvad exit nodes, and nodes of users you share with (unless includeShared: true), are left out and listed under skipped.
  • write: true writes the dedicated file ~/.ssh/tailscale_dev_config and returns the Include tailscale_dev_config instruction for ~/.ssh/config (never applied automatically).
  • target: "user_ssh_config" (with write: true) edits ~/.ssh/config directly, idempotently, between # BEGIN tailscale-mcp and # END tailscale-mcp markers. Content outside the markers is never touched. If the markers are malformed (orphaned, reversed, or duplicated) the tool returns SSH_CONFIG_MARKERS_CORRUPT and writes nothing.
  • Writes are atomic (temp file + rename), the previous ~/.ssh/config is kept as config.tailscale-mcp.bak, new files are created 0600 (existing modes are kept), and a symlinked config is written through rather than replaced.
json
{  "dryRun": true,  "hostCount": 2,  "configText": "# BEGIN tailscale-mcp\nHost raspi\n    HostName raspi.tail1234.ts.net\n\nHost devbox\n    HostName devbox.tail1234.ts.net\n# END tailscale-mcp"}

share_port

Shares a local port via Tailscale Serve. Tailnet-only by default. Inputs: port (required), public, path.

json
{"port": 3000, "public": false, "scope": "tailnet-only (Serve)", "urls": ["https://devpc.tail1234.ts.net/"]}

public: true switches to Funnel and exposes the port to the open internet. It's refused unless TAILSCALE_MCP_ALLOW_FUNNEL=1 is set; see the security notes below.

share_status

Reports active Serve/Funnel sessions as structured endpoints, parsed from tailscale serve status --json. Each endpoint has its own public flag, which is true when Funnel exposes it to the internet, and publicExposure is true when anything is public:

json
{  "active": true,  "publicExposure": true,  "endpoints": [    {"url": "https://devpc.tail1234.ts.net/", "host": "devpc.tail1234.ts.net", "httpsPort": 443, "scheme": "https", "path": "/", "target": "http://127.0.0.1:3000", "targetType": "proxy", "public": true, "foreground": false}  ]}

Raw TCP forwards appear under tcpForwards. On CLIs too old for --json, the text status comes back under status and publicExposure is null.

stop_share

Stops shares. Name exactly one target:

  • httpsPort and/or path turns off one mount. httpsPort is the serve port shown in share_status (default 443, not the proxied local port), and path is the mount path given to share_port (default /). For example, {"path": "/api"} undoes share_port {"port": 3000, "path": "/api"}.
  • mine: true stops only the shares share_port created during this server session.
  • all: true clears the entire serve/funnel configuration, including shares you set up outside this server.

With no arguments nothing is stopped: the tool returns TARGET_REQUIRED and lists the active endpoints. Every successful call returns removed (the endpoints that went away) and remaining (the share_status view afterwards).

Mount paths must start with / and use only letters, digits, and . _ ~ - /, with no . or .. segments. A trailing slash is dropped.

ping_all

Concurrent tailscale ping against peers (bounded to 5 in flight, with a per-ping timeout). Inputs: count, timeoutMs, onlineOnly (default true).

json
{  "pinged": 2,  "reachable": 1,  "timedOut": false,  "matrix": [    {"hostname": "raspi", "target": "100.101.1.20", "reachable": true, "latencyMs": 3, "path": "direct", "via": "192.168.1.20:41641", "attempts": 3, "replies": 3},    {"hostname": "exitbox", "target": "100.101.1.40", "reachable": false, "latencyMs": null, "path": null, "via": null, "attempts": 1, "replies": 0}  ]}

path is direct (peer-to-peer), derp (relayed through a Tailscale DERP server), peer-relay (relayed through one of your nodes), or unknown, so an agent can tell "works but relayed" from "fast direct path". tailscale ping keeps pinging until a direct path comes up, so path and latencyMs describe the last reply, i.e. the settled path. The whole call is capped at 45 seconds: peers that haven't answered by then come back with an error and timedOut: true.

Agentic workflow example

An agent asked to "deploy this to my dev VPS and show me the result" can do the whole discovery leg through this server:

  1. tailnet_status {"onlineOnly": true} finds the VPS node and its MagicDNS name (devbox.tail1234.ts.net), with no hardcoded IPs.
  2. generate_ssh_config {"write": true, "user": "deploy"} writes ~/.ssh/tailscale_dev_config; the agent shows the returned one-line Include instruction, and after the user adds it, ssh devbox resolves through the tailnet.
  3. ping_all confirms the node is reachable and whether the path is direct or relayed before starting a large transfer.
  4. After deploying, share_port {"port": 8080} returns a tailnet-only URL teammates on the tailnet can open. Nothing touches the public internet unless you have enabled Funnel with TAILSCALE_MCP_ALLOW_FUNNEL=1 and the agent is explicitly told to pass public: true.

Security notes on Funnel

  • share_port defaults to tailnet-only Serve. Nothing is reachable from outside your tailnet.
  • Funnel is off unless you turn it on. public: true uses Tailscale Funnel, which makes the URL reachable by anyone on the internet, not just your tailnet. A default install refuses it with FUNNEL_DISABLED, so a prompt-injected agent can't expose a port by itself. To allow it, set TAILSCALE_MCP_ALLOW_FUNNEL=1 in the client config. Even then the tool description carries the warning, so agents surface it before acting.
  • TAILSCALE_MCP_READONLY=1 removes the share tools entirely, for agents that should only observe.
  • Serve and Funnel must be enabled per-tailnet in the admin console. When they are not, the tool returns a structured SERVE_NOT_ENABLED error containing the exact enablement URL and changes nothing.
  • stop_share {"all": true} is the kill switch: it clears the entire serve/funnel configuration. Calling it without arguments never deletes anything.
  • This server never reads or stores TS_AUTHKEY or any other credential.

Development

bash
npm installnpm run build      # tscnpm test           # vitest, fully offline (fixture-driven, no live tailnet)npm run typecheck  # src and testsnpm run gen:tools  # regenerate mcp-tools.json after changing a tool

To try your build against your own tailnet, run it in the MCP Inspector:

bash
npm run buildnpx @modelcontextprotocol/inspector node dist/index.js

Provider adapter pattern: src/providers/types.ts defines the TailscaleProvider interface; CliProvider (the only implementation today) spawns the CLI through an injectable process runner so tests never launch a real binary. The interface leaves room for a future LocalAPI provider speaking HTTP over the local socket or named pipe.

Project Structure

tailscale-mcp/  src/index.ts        stdio entry point  src/config.ts       Environment variable parsing  src/providers/      TailscaleProvider interface + CliProvider  src/tools/          MCP tool registrations and output schemas  src/sshconfig.ts    Pure ssh-config rendering and managed-block editing  src/__tests__/      vitest suites (offline, mocked CLI runner)  test/fixtures/      Sanitized CLI output used by the tests  mcp-tools.json      Generated tool definitions (npm run gen:tools)  docs/               GitHub Pages site  .github/            CI/CD workflows

Roadmap

See ROADMAP.md for the full project roadmap.

Contributing

See CONTRIBUTING.md for guidelines.

License

CC-BY-NC-ND-4.0 -- see LICENSE for details.


Built by TMHSDigital

來源:README.md,提交 ebcca59

工具

6

tailnet_status

Tailnet status

Report the state of the local tailnet: this node plus all peers with hostname, MagicDNS name, Tailscale IPv4/IPv6, OS, online flag, last seen, exit-node flags, and tags. Returns a structured error with the exact fix command when the tailscale binary is missing, the daemon is stopped, or the device needs login.

輸入參數onlineOnly

generate_ssh_config

Generate SSH config

Generate ssh-config Host blocks for tailnet nodes (MagicDNS name preferred, Tailscale IP fallback). Dry-run by default: returns the generated config text only and writes nothing. With write=true it writes a dedicated file (~/.ssh/tailscale_dev_config) and returns instructions for adding an Include line to ~/.ssh/config (never applied automatically). Direct editing of ~/.ssh/config itself additionally requires target="user_ssh_config" and is idempotent between managed markers, never touching content outside them.

輸入參數userwritetargetonlineOnlyincludeShared

share_status

Share status

Report the active Tailscale Serve/Funnel sessions on this node: one entry per endpoint with its URL, serve port, mount path, proxied target, and a public flag that is true when Funnel exposes it to the open internet. publicExposure is true when anything is public.

無需輸入參數。

share_port

Share a local port

Share a local port over the tailnet via Tailscale Serve (tailnet-only by default). WARNING: setting public=true switches to Funnel and exposes the port to the OPEN INTERNET — anyone with the URL can reach it. Only set public=true when internet exposure is explicitly intended. Funnel is DISABLED on this server: public=true returns FUNNEL_DISABLED unless the user sets TAILSCALE_MCP_ALLOW_FUNNEL=1. Returns the resulting URL(s).

輸入參數pathport必填public

stop_share

Stop sharing

Stop Serve/Funnel shares: one mount, the shares this server created, or all of them, reporting what was removed. Name exactly one target: httpsPort and/or path turns off that one mount (httpsPort is the serve port shown in share_status, typically 443, not the proxied local port; path is the mount path given to share_port, default "/"); mine=true stops only the shares this server created in this session; all=true clears the entire serve/funnel configuration, including shares set up outside this server. With no arguments nothing is stopped and the active endpoints are listed. Returns what was removed and what remains.

輸入參數allminepathhttpsPort

ping_all

Ping all peers

Ping tailnet peers concurrently (bounded to 5 at a time, with a per-ping timeout) and return a latency matrix: node, latency ms of the settled path, path (direct, DERP relay, or peer relay), or unreachable. Defaults to online peers only. The whole call is capped at 45s; peers not answered by then are reported with an error and timedOut is true.

輸入參數counttimeoutMsonlineOnly

版本歷史

1
  1. v0.4.0最新Oct 26, 2026

評分

已滿足適用檢查項的 80%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分
  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分

    請在儲存庫或註冊中心條目中宣告授權條款。