mcp-install-instructions-generator

The mcp-install-instructions-generator MCP server provides a tool to generate ready-to-use installation instructions for your own MCP server deployments. It supports generating instructions in various formats (for example Markdown) and can be driven from either a remote MCP server URL or a local instance started via npx. You can use the CLI (npx) to run a local server that serves instructions based on a URL you provide, or you can access the remote service hosted by HyprMCP to generate docs for any MCP server URL. The package also ships a web component and a JavaScript API for embedding or programmatically generating instructions in your own apps.

To use the local server, you run the MCP server using the npx command, which boots a temporary local instance of the generator. Then supply the target MCP URL, the desired output format, and any options (e.g., target VS Code, output MD). The resulting instructions describe how to install and operate your MCP server, including prerequisites, commands, and environment considerations. The generator supports common targets such as vscode and various output formats like md, and it can be integrated into your CI/CD or docs workflow via its API or CLI.

Prerequisites:

• Node.js and npm (or corepack) installed on your machine
• Internet access to pull the generator package from npm

Step-by-step installation:

1. Install Node.js from https://nodejs.org/ (this includes npm).

2. Open a terminal or command prompt.

3. Run the local MCP server using npx (this downloads the generator package on demand and starts the server):

   npx -p @hyprmcp/mcp-install-instructions-generator@latest mcp

4. Once the server starts, open the provided local URL in your browser or use the CLI options to generate instructions for a specific MCP URL. For example, you can point the generator at your MCP server URL and request output in Markdown for VS Code:

   npx @hyprmcp/mcp-install-instructions-generator@latest https://mcp.example.com --target vscode --output md

5. If you prefer to use the remote HyprMCP-hosted server, you can invoke the generator against the remote service URL instead of running a local server. The remote endpoint is described in the documentation and examples on the official site.

6. Optional: integrate the generator into your project as a library or via their web component or npm package for automated generation in CI/CD pipelines.

Notes and tips:

• The CLI examples show using npx to run the generator locally; you can also generate instructions for a remote MCP server by supplying the target URL directly.
• Supported targets include vscode and other editors; the output can be generated in formats such as Markdown (md) or other supported formats depending on the version.
• When running locally, the server acts as a tiny HTTP service that accepts a URL and options to render installation instructions. Ensure your network allows pulling the generator package and that the target MCP URL is reachable.
• If you run into network or permission issues with npx, you can install the package temporarily or use a package manager equivalent to npm/yarn to install and run the CLI.
• The web component and JavaScript API are available for embedding the generator in web apps or documentation portals.