Install

Search for Digital IDE (sterben.fpga-support) in Extensions, or install a matching VSIX from Releases using Install from VSIX. Use a package containing backend resources for the target operating system and CPU architecture.

The current backend is digital-server. In Output → Digital-IDE, check Digital Server executable and startup errors. A missing executable usually requires a complete matching package containing resources/server/<platform>/<arch>/digital-server (.exe on Windows).

Install dide-mcp

dide-mcp is provided by Digital IDE's digital-server backend. It lets MCP clients inspect projects, operate waveform views, and use configured simulators and toolchains. Install an extension build that includes this feature, then connect your AI client to the backend managed by the extension.

Start the extension backend

1. Open the project folder in VS Code and ensure the workspace is trusted. With Remote SSH, install the extension on the remote host.
2. Wait for the extension to start the MCP backend automatically; it is enabled by default. Only if you previously disabled digital-ide.mcp.enabled, restore it to true and run Developer: Reload Window.
3. Open Output → Digital-IDE and wait for initialization. Record the absolute executable path from Digital Server executable and the absolute endpoint.json path following DIDE MCP ready ... Endpoint:.

The extension generates a connection file for the workspace; use the path reported by the current window. Keep that project window open while using MCP, because the backend stops when the extension exits. The connection file contains an authentication token; do not paste its contents into chats or commit it to Git.

Connect Codex

Run these commands on the same host as the extension backend, under a user that can access both files. Replace the example paths with the logged absolute paths and retain the quotes. On Windows, the executable is named digital-server.exe.

codex mcp add dide-mcp -- "/absolute/path/to/digital-server" dide-mcp --connect "/absolute/path/to/endpoint.json"
codex mcp get dide-mcp

--connect starts a stdio adapter that reuses the extension's running backend. With Remote SSH, run the corresponding Codex client on the remote host; remote paths cannot be executed as local Windows processes. Use codex mcp add --help to inspect the command syntax.

Reopen the AI session so the client discovers the service and tools. Call list_wave_views first; an empty list is valid when no views are open. Then call get_project to confirm the expected workspace. codex mcp get only confirms registration; a successful tool call verifies the actual connection.

Connect another MCP client

Select stdio transport, use the absolute digital-server path as the command, and pass dide-mcp, --connect, and the absolute connection-file path as separate arguments. Clients accepting the mcpServers format can use:

{
  "mcpServers": {
    "dide-mcp": {
      "command": "/absolute/path/to/digital-server",
      "args": ["dide-mcp", "--connect", "/absolute/path/to/endpoint.json"]
    }
  }
}

Merge this into the existing configuration while preserving other services. Windows JSON paths may use C:/.../digital-server.exe. Follow your client's requirements for the configuration location and enclosing fields.

Prompt for AI-assisted installation

Copy the following prompt directly into an AI assistant with terminal and file access. Nothing needs to be filled in or replaced. The assistant will identify the client, current project, and environment, locate the actual paths, and configure the connection.

Install and configure dide-mcp for my current Digital IDE project, then verify a real connection.

Discover the required information from the current session, working directory, VS Code workspace, extension installation, and logs. Do not ask me to fill in the client name, host, project path, or executable path in advance.

Follow these steps:
1. Automatically identify the current AI client, target project, and the host, operating system, and user for both the client and Digital IDE backend. Use session and workspace context to identify a local or Remote SSH environment, ensuring remote paths are used by processes on that remote host.
2. Check the Digital IDE installation and backend status. MCP starts automatically by default, so no setting needs to be added. If it was explicitly disabled, explain and address that state. The backend requires an open, trusted VS Code project window. Only report a concrete blocker and the minimum manual action when access is unavailable or a UI action genuinely requires me.
3. Automatically locate Digital Server executable and the DIDE MCP ready Endpoint using the project's Digital-IDE output, extension logs, and installation directory. Verify both files exist and match the target project. With multiple windows, match the workspace and logs rather than selecting the first result. Do not guess paths, create endpoint.json, or print its authentication token.
4. Use the discovered absolute digital-server path as the stdio command, followed by the arguments dide-mcp, --connect, and the discovered absolute endpoint.json path. This service is provided by digital-server; do not run npm install dide-mcp.
5. Locate the current client's MCP configuration entry point and preserve other services. For Codex, inspect the existing registration and codex mcp add --help, construct and execute codex mcp add with the actual paths, then run codex mcp get dide-mcp. For another client, write the same command and arguments in its required format. Reuse a correct existing registration without asking me to assemble commands or substitute paths.
6. Rediscover MCP tools and actually call list_wave_views and get_project to verify connectivity and the expected workspace. If the current session must be reopened, explain how to reopen it and which verification calls to run afterward; do not report success before verification.
7. Report the execution host, changed configuration files, service name, executable path, connection-file path, and actual verification results. Keep verification read-only: do not edit HDL, start simulation, or launch vendor builds.

Troubleshooting

Symptom	What to check
No DIDE MCP ready message	Open a trusted workspace, enable MCP, and check backend initialization. Reload the window after changing the setting.
Missing endpoint.json or connection failure	Keep the project window open, obtain the path from current logs, and check that the client runs on the same host with access to the files.
Tools are not visible	Reopen the AI session or rediscover services. Check that arguments include dide-mcp --connect.
A tool requires the extension backend	Use --connect. Standalone stdio mode does not attach to the current VS Code project and UI.

Next, open and configure your project.

Display language

Digital IDE menus, settings, notifications, project tools, IP configuration, build reports and Webviews support English, Simplified Chinese, Traditional Chinese, German, Japanese, French and Russian. Use VS Code's Configure Display Language and reload the window. Remote SSH uses the client's display language.

The waveform Settings panel also provides a separate persistent language choice. Standalone browser pages accept query parameters such as ?locale=de. Unsupported languages fall back to English.

Project fields, signal names, paths, snippet source bodies and raw vendor logs stay unchanged. Vendor IP parameter names use the metadata supplied by Vivado.

Run from source

From the repository root:

./extension/scripts/debug-digital-ide.sh

The script defaults to tests/project/temp, builds the WebUIs, extension and debug backend, then asks the current VS Code window to launch an Extension Development Host. Read --help; use --no-build only when artifacts are current. Vite requires a compatible Node.js version (20.19+ or 22.12+); backend builds need the repository's Rust dependencies.

Development launches can select the backend with DIGITAL_SERVER_PATH. Verify the actual executable in Output.

External tools

Install the simulator or vendor tool and its required license before using its workflow. Configure paths as described in Toolchain path configuration. With Remote SSH, both paths and executables belong to the remote host. For startup failures inspect launcher/extension logs; for missing icons or Webviews inspect failed resource requests in Developer: Toggle Developer Tools.