Skip to content

Doc2X MCP Guide

This guide explains how to integrate Doc2X MCP in different clients and call Doc2X services via MCP.

Note: MCP (stdio) means the client starts a local process (here npx ...doc2x-mcp) and communicates through stdin/stdout. Network/proxy settings, Node.js availability, and environment variable injection will directly affect whether it works.

Prerequisites

  • Please obtain a Doc2X API Key (example: sk-xxx). Get it from: open.noedgeai.com
  • Install Node.js and make sure npx is available
  • Ensure the network can reach Doc2X services (configure proxy if needed)

Versioning Tips

  • For team/production usage, pin the package version (for example @noedgeai-org/doc2x-mcp@0.1.0) to avoid unexpected upstream changes.
  • For quick trials, you may use @latest, but pin a known-good version when troubleshooting.

Proxy / Registry Notes

  • If you need a proxy, make sure the process running MCP can access it (for example HTTPS_PROXY / HTTP_PROXY).
  • If dependency installation is slow or fails, try switching the npm registry (for example via npm_config_registry).

Generic MCP Configuration

Add a configuration similar to the following in a client that supports MCP (stdio):

json
{
  "command": "npx",
  "args": ["-y", "@noedgeai-org/doc2x-mcp@0.1.0"],
  "env": {
    "DOC2X_API_KEY": "sk-xxx",
    "DOC2X_BASE_URL": "https://v2.doc2x.noedgeai.com"
  }
}

Environment Variables

  • DOC2X_API_KEY: Doc2X API Key (required)
  • DOC2X_BASE_URL: Doc2X API Base URL (optional)

Client Guides

  • Codex: terminal-first, great for parsing/exporting from a local directory
  • Claude Code: terminal-first, declarative MCP add command
  • Gemini CLI: terminal-first, good for scripted flows
  • Cherry Studio: GUI setup, but more sensitive to network and local file permissions

Security

  • Do not commit or share your DOC2X_API_KEY in repositories, screenshots, or logs.

Troubleshooting

  • npx not found
    • Make sure Node.js is installed (LTS recommended)
    • Reopen your terminal or check your PATH
  • Dependency installation is slow or fails
    • Check network/proxy settings
    • Try switching to another npm registry mirror
  • API Key not taking effect
    • Ensure DOC2X_API_KEY is injected when starting the MCP server
    • Check client logs to confirm environment variables are loaded