English Français العربية

zoxide-doctor

Official registry Health

Read-only local zoxide diagnostics for MCP clients.

Source code Website Documentation

What can you do with zoxide-doctor?

  • Checks whether zoxide and optional fzf are on PATH.
  • Checks that zoxide init produces shell initialization code.
  • Returns a machine-readable JSON report, including the matching zoxide.org setup and troubleshooting guides.
  • Reads conventional shell profile paths only when the MCP caller sets scan_config: true.

Install

Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).

NPM package @agoes/zoxide-doctor-mcp
Claude Code 
claude mcp add zoxide-doctor -- npx -y @agoes/zoxide-doctor-mcp@0.1.2
JSON configuration (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "zoxide-doctor": {
            "command": "npx",
            "args": [
                "-y",
                "@agoes/zoxide-doctor-mcp@0.1.2"
            ]
        }
    }
}

Documentation

From the project's README on GitHub, refreshed weekly. Links open on GitHub.

Contents
  1. zoxide-doctor MCP server
  2. What it does
  3. Install for an MCP client
  4. Development
  5. License

zoxide-doctor MCP server

@agoes/zoxide-doctor-mcp gives MCP clients one local, read-only tool for diagnosing zoxide installation and shell setup. It wraps the published zoxide-doctor diagnostic core; it does not install zoxide or modify shell configuration files.

This is an independent community integration. It is not affiliated with or endorsed by the official zoxide project.

What it does

  • Checks whether zoxide and optional fzf are on PATH.
  • Checks that zoxide init produces shell initialization code.
  • Returns a machine-readable JSON report, including the matching zoxide.org setup and troubleshooting guides.
  • Reads conventional shell profile paths only when the MCP caller sets scan_config: true.

Install for an MCP client

Use an MCP client configuration that starts the local stdio server with npx:

{
  "mcpServers": {
    "zoxide-doctor": {
      "command": "npx",
      "args": ["-y", "@agoes/zoxide-doctor-mcp"]
    }
  }
}

The server exposes one tool:

diagnose_zoxide({ shell?: "bash" | "zsh" | "fish" | "powershell" | "nushell" | "elvish" | "tcsh" | "xonsh" | "posix", scan_config?: boolean })

scan_config is opt-in because it reads conventional shell-profile files. The tool never writes files or changes shell state.

Development

npm install
npm run lint
npm test
npm run validate:metadata
npm run pack:check
npm run smoke

server.json is kept version-locked to package.json and sets the MCP Registry websiteUrl to the zoxide-doctor guide.

License

MIT

Frequently asked questions

What is zoxide-doctor?

Read-only local zoxide diagnostics for MCP clients.

How do I install zoxide-doctor?

It runs on your machine. In Claude Code: claude mcp add zoxide-doctor -- npx -y @agoes/zoxide-doctor-mcp@0.1.2. For other clients, paste the JSON configuration from this page into their MCP settings.

Does zoxide-doctor need an API key?

Its registry entry lists no required key or secret. Some features may still need an account with the service it connects to.

Is zoxide-doctor open source?

Yes. Its code is on GitHub under the MIT license.

Who maintains zoxide-doctor?

It is published by jiankn. AI.tn lists it but does not maintain or endorse it.

From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.