Nullplatform MCP API Server

Exposes the Nullplatform OpenAPI as an MCP so LLMs can discover, understand, and interact with API endpoints.

typescript

0

GitHub Stars

typescript

Language

6 months ago

First Indexed

3 months 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": {
    "nullplatform-mcp-api": {
      "command": "npx",
      "args": [
        "@nullplatform/mcp-api"
      ],
      "env": {
        "NP_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

You can interact with the Nullplatform API through a dedicated MCP server that loads the official OpenAPI spec and exposes every endpoint as a callable function. This enables the LLM to discover, understand, and invoke API endpoints for deployments, scopes, services, and more, with in-place reasoning over a large toolset.

How to use

You connect to the MCP server using your MCP client, then issue requests by calling the exposed functions as if you were calling local tools. You can list resources, retrieve details, create new items, and modify existing ones. Follow guidance such as retrieving identifiers required for operations, inspecting request bodies, and understanding required parameters for each endpoint before attempting an action.

How to install

Prerequisites: Node.js and npm or npx available on your system. Docker can also be used if you prefer containerized execution.

Additional content

Install and run the MCP server using one of the provided methods. The server exposes endpoints via functions you can call, and it includes environment variable configurations to authorize access to the underlying API.

Available tools

list_deployments

List all deployments in your project, showing basic metadata and identifiers.

get_deployment

Retrieve detailed information for a specific deployment by its identifier.

create_deployment

Create a new deployment with the required parameters and initial configuration.

modify_deployment

Update properties of an existing deployment, such as name, labels, or resources.

list_scopes

List all scopes available to group and organize resources.

get_scope

Get details for a specific scope by its identifier.

create_scope

Create a new scope to organize deployments or services.

modify_scope

Update an existing scope’s metadata or configuration.

list_services

List all services exposed by the platform.

get_service

Retrieve information about a specific service.

modify_service

Update the configuration or state of a service.