Petstore

Provides a sample Pet Store API server for OpenAPI 3.1 with environment-based start options and an API key.

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": {
    "rachana-tf-mcp-poc-app": {
      "command": "npx",
      "args": [
        "petstore",
        "start",
        "--environment",
        "...",
        "--api-key",
        "..."
      ],
      "env": {
        "API_KEY": "...",
        "ENVIRONMENT": "..."
      }
    }
  }
}

You can run a lightweight Pet Store server based on the OpenAPI 3.1 specification as an MCP server. It starts locally with environment-specific options and an API key, making it easy to test, demo, or integrate with clients.

How to use

Once the MCP server is running, you can connect your MCP client or tooling to start interacting with the Pet Store API. Use the provided start command with your environment and API key to launch the server in your preferred environment. This server is designed to be lightweight for local development and testing.

How to install

Prerequisites you need to have installed on your machine:

Node.js 12+ (npm comes with Node)
A package manager you prefer (npm, yarn, pnpm, bun)

Choose one of the following runtime methods to install and run the Pet Store MCP server.

Install and run via stdio configuration

Use the standard input/output (stdio) method shown here. This runs the server locally using npx with the Pet Store package.

npx petstore start --environment ... --api-key ...

Install configuration example (JSON for MCP setup)

If you manage MCP configurations via a JSON file, you can define the Pet Store MCP server as shown below. This configuration uses an executable command and arguments to start the server.

{
  "mcpServers": {
    "Petstore": {
      "command": "npx",
      "args": [
        "petstore",
        "start",
        "--environment",
        "...",
        "--api-key",
        "..."
      ]
    }
  }
}

Cursor and other integration options

If you manage MCP installations through integration tools, you can paste the same configuration into the tool of your choice. The base configuration uses the same command and arguments to start the server.

{
  "mcpServers": {
    "Petstore": {
      "command": "npx",
      "args": [
        "petstore",
        "start",
        "--environment",
        "...",
        "--api-key",
        "..."
      ]
    }
  }
}

Environment variables and secrets

Provide your environment value and API key when starting the server. Use placeholders in examples and replace them with your actual values in your environment.