N|Solid Console MCP integration (IDE)

The N|Solid Console includes a Model Context Protocol (MCP) server that lets an AI assistant in your IDE or agent query Console data and run diagnostics such as CPU profiles and heap snapshots. This page shows how to find the MCP endpoint, authenticate with a service token, and add the server to Visual Studio Code, Cursor, or Windsurf.

tip

If you use the N|Solid IDE extension, signing in and clicking Install Toolkit configure this server for you, together with the ncm and ns-benchmark MCP servers and a local nsolid-local server. The same is true for the N|Solid plugin for Claude Code, Codex, and other agent CLIs (install the plugin, then run nsolid-plugin setup).

MCP endpoint

The MCP server uses the streamable HTTP transport and is served at the root path (/).

Console	MCP server URL
N|Solid SaaS	https://<organization-id>.mcp.saas.nodesource.io
Self-hosted N|Solid Console	http://<console-host>:6277/

For N|Solid SaaS, <organization-id> is your NodeSource organization ID (a UUID). It usually matches the first part of your N|Solid SaaS Console URL (https://<organization-id>.saas.nodesource.io). If your Console is reachable under a custom name, use the organization ID, not the custom name.

On a self-hosted N|Solid Console, the MCP server listens on port 6277 by default. Change the port with the port key in the [mcp] section of the Console configuration file, or with the NSOLID_CONSOLE_MCP_PORT environment variable.

Authentication

The MCP server authenticates requests with a NodeSource Accounts service token. Send the token in either of these headers:

• X-Nsolid-Service-Token: <your-service-token>
• Authorization: Bearer <your-service-token>

Most tool calls are checked against the token's permissions (see Tools and required permissions). Requests are rate-limited to 200 per minute per token. Excess requests are queued.

tip

Create a dedicated service token for your IDE agent, and grant only the permissions you want the agent to have. To create one, see Service tokens.

warning

If a self-hosted N|Solid Console runs without login enabled, the MCP server doesn't check token permissions: any non-empty token value is accepted, and every tool is available. Don't expose the MCP port on untrusted networks.

Configure Visual Studio Code

In VS Code, add MCP servers with the MCP: Add Server command, or edit .vscode/mcp.json in your workspace. This example prompts for the token once and stores it in VS Code's secret storage instead of the file:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "nsolid-service-token",
      "description": "N|Solid service token",
      "password": true
    }
  ],
  "servers": {
    "nsolid-console": {
      "type": "http",
      "url": "https://<organization-id>.mcp.saas.nodesource.io",
      "headers": {
        "X-Nsolid-Service-Token": "${input:nsolid-service-token}"
      }
    }
  }
}

Configure Cursor or Windsurf

Cursor reads MCP servers from .cursor/mcp.json in your workspace or ~/.cursor/mcp.json. Windsurf reads them from ~/.codeium/windsurf/mcp_config.json. Both use an mcpServers object. This example uses the Windsurf format (in Cursor, use url instead of serverUrl):

{
  "mcpServers": {
    "nsolid-console": {
      "serverUrl": "https://<organization-id>.mcp.saas.nodesource.io",
      "headers": {
        "Authorization": "Bearer <your-service-token>"
      }
    }
  }
}

warning

Keep the service token out of your repository. If you put the token directly in a configuration file inside your project, add that file to .gitignore, or use your editor's secret storage or environment-variable support instead.

Verify the integration

After you add the server:

• Confirm the service token belongs to the organization whose Console you're connecting to.
• Confirm the MCP server is listed as running or enabled in your IDE.
• Run a safe, read-only tool first. For example, ask the agent for a list of connected applications.

Tools and required permissions

The MCP server exposes Console API endpoints as tools. Each tool requires one service-token permission, except health, host-uptime, and serverless-functions, which don't require a permission:

Tool	Required permission
health, host-uptime, serverless-functions	None
application-packages, asset-summary, assets, assets-in-progress, global-filter, information-dashboard, packages, runtime-code, server-info	Assets
events-historic, metrics-dashboard, metrics-historic, tracing, tracing-detail	View events historic
profile	Generate CPU profile
snapshot, track-heap-objects	Generate heap snapshot
heap-sampling	Generate heap sample
sbom	Generate SBOM
vulnerabilities	Security vulnerabilities

The available tools depend on your Console version. To see the list for your Console, ask the agent to list its tools, or open Settings > About in the N|Solid Console, click the link next to Api Reference, and scroll to the MCP TOOLS section.

Troubleshooting

If tools are missing or calls fail, check that:

• The MCP server is reachable from your machine.
• The MCP server URL is correct. For N|Solid SaaS, it must use your organization ID: https://<organization-id>.mcp.saas.nodesource.io.
• The service token is present in the server's headers.
• The token has the permission required by the tool you're calling.