@omkar273/mcp-temp 0.0.46 → 0.0.50

package/README.md

@@ -1,14 +1,25 @@
-# FlexPrice MCP Server
+# flexprice MCP Server
 
-A Model Context Protocol (MCP) server that exposes the FlexPrice API as tools for AI assistants (e.g. Claude, Cursor, VS Code, Windsurf). Use it to manage customers, plans, prices, subscriptions, invoices, payments, events, and more from your IDE or CLI.
+A Model Context Protocol (MCP) server that exposes the flexprice API as tools for AI assistants (e.g. Claude, Cursor, VS Code, Windsurf). Use it to manage customers, plans, prices, subscriptions, invoices, payments, events, and more from your IDE or CLI.
+
+## Table of contents
+
+- [Prerequisites](#prerequisites)
+- [How to use the flexprice MCP server](#how-to-use-the-flexprice-mcp-server)
+- [Add to your MCP client](#add-to-your-mcp-client)
+- [Tools](#tools)
+- [Progressive discovery (dynamic mode)](#progressive-discovery-dynamic-mode)
+- [Scopes](#scopes)
+- [Troubleshooting](#troubleshooting)
+- [Generating the MCP server](#generating-the-mcp-server)
 
 ## Prerequisites
 
 - **Node.js** v20 or higher
 - **npm** or **yarn**
-- **FlexPrice API key** from your [FlexPrice account](https://app.flexprice.io)
+- **flexprice API key** from your [flexprice account](https://app.flexprice.io)
 
-## How to use the FlexPrice MCP server
+## How to use the flexprice MCP server
 
 You can run the server in two ways: **npm package** (one command) or **local repo** (clone and run). Pick one, then [add it to your MCP client](#add-to-your-mcp-client).
 
@@ -16,13 +27,13 @@ You can run the server in two ways: **npm package** (one command) or **local rep
 
 ### Option 1: npm package
 
-Install: `npm i @omkar273/mcp-temp`. Or run with one command (no clone or build):
+Install: `npm i @flexprice/mcp-server`. Or run with one command (no clone or build):
 
 ```bash
-npx @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY
+npx @flexprice/mcp-server start --server-url https://us.api.flexprice.io/v1 --api-key-auth YOUR_API_KEY
 ```
 
-Replace `YOUR_API_KEY` with your FlexPrice API key. Next: [Add to your MCP client](#add-to-your-mcp-client).
+Replace `YOUR_API_KEY` with your flexprice API key. Next: [Add to your MCP client](#add-to-your-mcp-client).
 
 ---
 
@@ -33,7 +44,7 @@ Use this if you want to change code or run without npm:
 1. Clone the repository and go to the MCP server directory (e.g. `api/mcp` or the repo that contains it).
 2. Install dependencies: `npm install`
 3. Create a `.env` file (from `.env.example` if present) with:
-   - `BASE_URL=https://api.cloud.flexprice.io/v1` (must include `/v1`, no trailing slash)
+   - `BASE_URL=https://us.api.flexprice.io/v1` (must include `/v1`, no trailing slash)
    - `API_KEY_APIKEYAUTH=your_api_key_here`
 4. Build: `npm run build`
 5. Start: `npm start`
@@ -42,14 +53,16 @@ Use this if you want to change code or run without npm:
 
 ```bash
 docker build -t flexprice-mcp .
-docker run -i -e API_KEY_APIKEYAUTH=your_api_key_here -e BASE_URL=https://api.cloud.flexprice.io/v1 flexprice-mcp node bin/mcp-server.js start
+docker run -i -e API_KEY_APIKEYAUTH=your_api_key_here -e BASE_URL=https://us.api.flexprice.io/v1 flexprice-mcp node bin/mcp-server.js start
 ```
 
 Next: [Add to your MCP client](#add-to-your-mcp-client) and use the **Node from repo** or **Docker** config below.
 
 ## Add to your MCP client
 
-Add the FlexPrice MCP server in your editor. Replace `YOUR_API_KEY` with your FlexPrice API key in all examples.
+Add the flexprice MCP server in your editor. Replace `YOUR_API_KEY` with your flexprice API key in all examples. Example config snippets are in [examples/](examples/).
+
+**After connecting:** In Cursor, open the MCP panel and confirm the server is connected. You can list tools and try an operation (e.g. list customers) from your assistant. In Claude, use `/mcp` to see connected servers and available tools.
 
 ### Config file locations
 
@@ -74,10 +87,10 @@ Add the FlexPrice MCP server in your editor. Replace `YOUR_API_KEY` with your Fl
       "command": "npx",
       "args": [
         "-y",
-        "@omkar273/mcp-temp",
+        "@flexprice/mcp-server",
         "start",
         "--server-url",
-        "https://api.cloud.flexprice.io/v1",
+        "https://us.api.flexprice.io/v1",
         "--api-key-auth",
         "YOUR_API_KEY"
       ]
@@ -101,10 +114,10 @@ Add the FlexPrice MCP server in your editor. Replace `YOUR_API_KEY` with your Fl
       "command": "npx",
       "args": [
         "-y",
-        "@omkar273/mcp-temp",
+        "@flexprice/mcp-server",
         "start",
         "--server-url",
-        "https://api.cloud.flexprice.io/v1",
+        "https://us.api.flexprice.io/v1",
         "--api-key-auth",
         "YOUR_API_KEY"
       ]
@@ -118,7 +131,7 @@ Add the FlexPrice MCP server in your editor. Replace `YOUR_API_KEY` with your Fl
 ### Claude Code
 
 ```bash
-claude mcp add FlexPrice -- npx -y @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY
+claude mcp add flexprice -- npx -y @flexprice/mcp-server start --server-url https://us.api.flexprice.io/v1 --api-key-auth YOUR_API_KEY
 ```
 
 Then run `claude` and use `/mcp` to confirm the server is connected.
@@ -136,10 +149,10 @@ Add to your Claude Desktop config file (path in the table above):
       "command": "npx",
       "args": [
         "-y",
-        "@omkar273/mcp-temp",
+        "@flexprice/mcp-server",
         "start",
         "--server-url",
-        "https://api.cloud.flexprice.io/v1",
+        "https://us.api.flexprice.io/v1",
         "--api-key-auth",
         "YOUR_API_KEY"
       ]
@@ -164,7 +177,7 @@ Quit and reopen Claude Desktop.
       "args": ["/path/to/mcp-server/bin/mcp-server.js", "start"],
       "env": {
         "API_KEY_APIKEYAUTH": "your_api_key_here",
-        "BASE_URL": "https://api.cloud.flexprice.io/v1"
+        "BASE_URL": "https://us.api.flexprice.io/v1"
       }
     }
   }
@@ -181,7 +194,7 @@ Quit and reopen Claude Desktop.
       "args": ["run", "-i", "--rm", "-e", "API_KEY_APIKEYAUTH", "-e", "BASE_URL", "flexprice-mcp"],
       "env": {
         "API_KEY_APIKEYAUTH": "your_api_key_here",
-        "BASE_URL": "https://api.cloud.flexprice.io/v1"
+        "BASE_URL": "https://us.api.flexprice.io/v1"
       }
     }
   }
@@ -192,7 +205,7 @@ After editing, save and **restart Cursor or quit and reopen Claude Desktop** so
 
 ## Tools
 
-The server exposes FlexPrice API operations as MCP tools. **Only operations with certain OpenAPI tags are included** (e.g. Customers, Invoices, Events). The allowed tags are configured in `api/mcp/.speakeasy/allowed-tags.yaml` in the repo; the filtered spec is `docs/swagger/swagger-3-0-mcp.json`. Tool names and parameters follow the OpenAPI spec. For the full list, see your MCP client’s tool list after connecting, or the OpenAPI spec (e.g. `docs/swagger/swagger-3-0.json`) in the repo.
+The server exposes flexprice API operations as MCP tools. **Only operations with certain OpenAPI tags are included** (e.g. Customers, Invoices, Events). The allowed tags are configured in the repo; the filtered spec is `docs/swagger/swagger-3-0-mcp.json`. Tool names and parameters follow the OpenAPI spec. For the full list, see your MCP client’s tool list after connecting, or the OpenAPI spec (e.g. `docs/swagger/swagger-3-0.json`) in the repo.
 
 ## Progressive discovery (dynamic mode)
 
@@ -205,7 +218,7 @@ Servers with many tools can bloat context and token usage. **Dynamic mode** expo
 To enable dynamic mode, add `--mode dynamic` when starting the server:
 
 ```json
-"args": ["-y", "@omkar273/mcp-temp", "start", "--server-url", "https://api.cloud.flexprice.io/v1", "--api-key-auth", "YOUR_API_KEY", "--mode", "dynamic"]
+"args": ["-y", "@flexprice/mcp-server", "start", "--server-url", "https://us.api.flexprice.io/v1", "--api-key-auth", "YOUR_API_KEY", "--mode", "dynamic"]
 ```
 
 This reduces tokens per request and can improve tool choice when there are many operations.
@@ -215,7 +228,7 @@ This reduces tokens per request and can improve tool choice when there are many
 If the server is configured with scopes (e.g. `read`, `write`), you can limit tools by scope:
 
 ```bash
-npx @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY --scope read
+npx @flexprice/mcp-server start --server-url https://us.api.flexprice.io/v1 --api-key-auth YOUR_API_KEY --scope read
 ```
 
 Use `read` for read-only access when the server defines a `read` scope.
@@ -225,14 +238,14 @@ Use `read` for read-only access when the server defines a `read` scope.
 ### "Invalid URL" or request errors
 
 - The server builds request URLs from `BASE_URL` + path. If `BASE_URL` is unset or wrong, requests fail.
-- **Fix:** Set `BASE_URL=https://api.cloud.flexprice.io/v1` (no trailing slash after `v1`). For npx, pass `--server-url https://api.cloud.flexprice.io/v1`.
+- **Fix:** Set `BASE_URL=https://us.api.flexprice.io/v1` (no trailing slash after `v1`). For npx, pass `--server-url https://us.api.flexprice.io/v1`.
 - If you get **404** on tool calls, ensure the base URL includes `/v1`.
 
 ### API connection issues
 
-1. **Credentials:** Check that your API key and base URL are correct. Test the key with the FlexPrice API (e.g. `curl -H "x-api-key: your_key" https://api.cloud.flexprice.io/v1/customers`).
-2. **Network:** Confirm the host can reach the FlexPrice API (firewall, proxy).
-3. **Rate limiting:** If you see rate-limit errors, reduce request frequency or contact FlexPrice support.
+1. **Credentials:** Check that your API key and base URL are correct. Test the key with the flexprice API (e.g. `curl -H "x-api-key: your_key" https://us.api.flexprice.io/v1/customers`).
+2. **Network:** Confirm the host can reach the flexprice API (firewall, proxy).
+3. **Rate limiting:** If you see rate-limit errors, reduce request frequency or contact flexprice support.
 
 ### Server issues
 
@@ -248,12 +261,11 @@ Use `read` for read-only access when the server defines a `read` scope.
 
 ## Generating the MCP server
 
-The server is generated with **Speakeasy** from a **tag-filtered** OpenAPI spec (`docs/swagger/swagger-3-0-mcp.json`), not the full spec. Only operations whose tags are listed in `api/mcp/.speakeasy/allowed-tags.yaml` are included. To regenerate after API or overlay changes:
+The server is generated from a tag-filtered OpenAPI spec (`docs/swagger/swagger-3-0-mcp.json`), not the full spec. Only operations whose tags are listed in the allowed-tags configuration are included. To regenerate after API or overlay changes:
 
-1. Install the [Speakeasy CLI](https://www.speakeasy.com/).
-2. (Optional) Edit `api/mcp/.speakeasy/allowed-tags.yaml` to add or remove tags; then run `make filter-mcp-spec` to rebuild the filtered spec.
-3. From the repo root, run `make sdk-all` (this runs `filter-mcp-spec` automatically, then generates the MCP server).
-4. Run `make merge-custom` so custom files (including this README) are merged into the output.
-5. Build and run: `npm run build` and `npm start` from the MCP output directory.
+1. (Optional) Edit the allowed-tags configuration to add or remove tags; then run `make filter-mcp-spec` to rebuild the filtered spec.
+2. From the repo root, run `make sdk-all` (this runs `filter-mcp-spec` automatically, then generates the MCP server).
+3. Run `make merge-custom` so custom files (including this README) are merged into the output.
+4. Build and run: `npm run build` and `npm start` from the MCP output directory.
 
-See the main repo README and [AGENTS.md](AGENTS.md) for SDK/MCP generation and publishing.
+See the main repo README and AGENTS.md for SDK/MCP generation and publishing.