Node

Provides a Node.js API docs MCP server that serves and debugs API documentation through simple MCP client connections.

javascript

8

GitHub Stars

javascript

Language

4 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "lirantal-mcp-server-nodejs-api-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-nodejs-api-docs"
      ]
    }
  }
}

This MCP server runs a Node.js-based API documentation service that you can quickly launch from your terminal or inside a container. It is designed to be easy to start, debug, and integrate with MCP clients, giving you a lightweight way to expose and explore API docs for Node.js projects.

How to use

You can run the MCP server directly with a simple command to start serving your Node.js API docs. Use a client that supports MCP servers to connect and browse the generated documentation. If you need to debug, you can inspect the server’s log to understand requests and responses.

How to install

Prerequisites: you should have Node.js and npm available on your system. You can also run the server in Docker if you prefer containerized execution.

Step 1: Ensure Node.js is installed on your machine. You can verify with:

Step 2: Install or run the MCP server directly using npx to avoid local installation.

npx mcp-server-nodejs-api-docs

Additional content

The server can also be run inside a Docker container. Pull the image and run it to serve MCP requests. You can also configure common MCP clients to connect to the server when it is running in Docker.

Debugging and logging: to inspect what the MCP server is doing, you can check the log file that is written to your system's temporary directory (for example, /tmp on Unix-like systems or %TEMP% on Windows). This helps you trace requests and diagnose issues.

Examples of client configuration and usage are provided for popular MCP clients. You can adapt these configurations to match your environment and the MCP client you use.

docker pull ghcr.io/lirantal/mcp-server-nodejs-api-docs:latest

Examples and practical tips

Using Docker is a convenient way to run the MCP server in isolation. After pulling the image, you can start a container and connect your MCP clients to the exposed server endpoints.

If you prefer desktop or integrated MCP clients, you can add the server to your client’s MCP configuration by referencing the npx-based command or the Docker image as shown in typical client setup snippets.

Available tools

npx-run

Launch the MCP server quickly without installation by executing the package with npx.

docker-run

Run the MCP server inside a Docker container using the official image.

log-inspect

Inspect the MCP server log file in the system's temporary directory to debug calls.