mcpField
Z
zoxide-doctor

zoxide-doctor

Local
zoxide.orgDeveloper Tools0Updated 12w ago

About zoxide-doctor

zoxide-doctor is a local, read-only MCP diagnostic tool for zoxide installation and shell setup. It reports findings as machine-readable JSON and does not install zoxide or change shell files.

Key features

  1. 01Check zoxide and optional fzf on PATH
  2. 02Check shell initialization output
  3. 03Return a machine-readable JSON report
  4. 04Optionally scan conventional shell profiles

Use cases

  1. 01Diagnose a missing zoxide executable
  2. 02Check whether shell initialization is configured
  3. 03Review shell profiles when explicitly enabled

MCP support

The local stdio MCP server exposes one tool, `diagnose_zoxide`. Configuration-file scanning is opt-in through `scan_config: true`; the tool does not write files or alter shell state.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
"mcpServers": {
"jiankn-zoxide-doctor": {
"command": "npx",
"args": [
"-y",
"@agoes/zoxide-doctor-mcp"
]
}
}
}
Run commandnpx -y @agoes/zoxide-doctor-mcp

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npm@agoes/zoxide-doctor-mcp0.1.2

Tools

1

Saved tool list · updated 3w ago

ParameterTypeRequiredDescription
shellenumNoShell to diagnose. Omit to use local shell detection.bash | zsh | fish | powershell | nushell | elvish | tcsh | xonsh | posix
scan_configbooleanNoWhen true, read conventional shell profile paths to check for zoxide initialization. Defaults to false.

Details

From the project README

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

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.