@fleetx_io/fleetx-mcp-server 1.0.0 → 1.0.2

package/README.md

@@ -1,7 +1,12 @@
 # @fleetx_io/fleetx-mcp-server
 
+[![npm](https://img.shields.io/npm/v/@fleetx_io/fleetx-mcp-server)](https://www.npmjs.com/package/@fleetx_io/fleetx-mcp-server)
+[![npm downloads](https://img.shields.io/npm/dm/@fleetx_io/fleetx-mcp-server)](https://www.npmjs.com/package/@fleetx_io/fleetx-mcp-server)
+
 An MCP (Model Context Protocol) server that gives AI agents access to the FleetX REST API. Install it as an npm package and connect it to any MCP-compatible client — no code required.
 
+**[View on npm](https://www.npmjs.com/package/@fleetx_io/fleetx-mcp-server)**
+
 ## How it Works
 
 1. Your AI agent (Cursor, Claude Desktop, Windsurf, etc.) launches this server as a subprocess.
@@ -14,16 +19,17 @@ An MCP (Model Context Protocol) server that gives AI agents access to the FleetX
 
 ## Quick Start
 
-### Install
+### Option A: Use directly with npx (no install)
 
 ```bash
-npm install -g @fleetx_io/fleetx-mcp-server
+npx -y @fleetx_io/fleetx-mcp-server
 ```
 
-Or use it directly with `npx` (no install needed):
+### Option B: Install globally
 
 ```bash
-npx @fleetx_io/fleetx-mcp-server
+npm install -g @fleetx_io/fleetx-mcp-server
+fleetx-mcp-server
 ```
 
 ---
@@ -34,6 +40,8 @@ npx @fleetx_io/fleetx-mcp-server
 
 Add to `.cursor/mcp.json` in your project root:
 
+**Using npx:**
+
 ```json
 {
   "mcpServers": {
@@ -45,6 +53,18 @@ Add to `.cursor/mcp.json` in your project root:
 }
 ```
 
+**Using global install:**
+
+```json
+{
+  "mcpServers": {
+    "fleetx": {
+      "command": "fleetx-mcp-server"
+    }
+  }
+}
+```
+
 Then restart Cursor. The server will appear in **Settings > MCP**.
 
 ### Claude Desktop
@@ -54,6 +74,8 @@ Add to your `claude_desktop_config.json`:
 **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
 **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
 
+**Using npx:**
+
 ```json
 {
   "mcpServers": {
@@ -65,10 +87,24 @@ Add to your `claude_desktop_config.json`:
 }
 ```
 
+**Using global install:**
+
+```json
+{
+  "mcpServers": {
+    "fleetx": {
+      "command": "fleetx-mcp-server"
+    }
+  }
+}
+```
+
 ### Windsurf
 
 Add to your Windsurf MCP config:
 
+**Using npx:**
+
 ```json
 {
   "mcpServers": {
@@ -80,22 +116,18 @@ Add to your Windsurf MCP config:
 }
 ```
 
-### Any MCP Client (Generic)
-
-Run the server as a subprocess communicating over **stdio**:
-
-```bash
-npx @fleetx_io/fleetx-mcp-server
-```
-
-Or if installed globally:
+**Using global install:**
 
-```bash
-fleetx-mcp-server
+```json
+{
+  "mcpServers": {
+    "fleetx": {
+      "command": "fleetx-mcp-server"
+    }
+  }
+}
 ```
 
-The server speaks JSON-RPC over stdin/stdout. Logs go to stderr.
-
 ---
 
 ## Usage
@@ -126,32 +158,6 @@ The full list depends on your account's enabled APIs.
 
 ---
 
-## Configuration (Optional)
-
-By default, the server connects to the FleetX production API. Override with environment variables if needed:
-
-```json
-{
-  "mcpServers": {
-    "fleetx": {
-      "command": "npx",
-      "args": ["-y", "@fleetx_io/fleetx-mcp-server"],
-      "env": {
-        "LOGIN_URL": "https://api.fleetx.io/api/v1/login",
-        "API_DEFINITION_URL": "https://app.fleetx.io/napp/api-reference/apis"
-      }
-    }
-  }
-}
-```
-
-| Variable | Default | Description |
-|----------|---------|-------------|
-| `LOGIN_URL` | `https://api.fleetx.io/api/v1/login` | Authentication endpoint |
-| `API_DEFINITION_URL` | `https://app.fleetx.io/napp/api-reference/apis` | API definitions endpoint |
-
----
-
 ## Security
 
 - Credentials are sent only to the FleetX login endpoint — never logged or stored on disk.
@@ -162,53 +168,25 @@ By default, the server connects to the FleetX production API. Override with envi
 
 ## Testing with MCP Inspector
 
-For debugging and exploring available tools:
+**With npx (no install):**
 
 ```bash
-npx @modelcontextprotocol/inspector npx @fleetx_io/fleetx-mcp-server
+npx -y @modelcontextprotocol/inspector npx -y @fleetx_io/fleetx-mcp-server
 ```
 
-This opens a web UI where you can connect, call `login`, browse all tools, and test them interactively.
-
----
-
-## Development
+**After installing the package globally:**
 
 ```bash
-git clone <repo-url>
-cd fleetx-mcp-server
-npm install
+npx -y @modelcontextprotocol/inspector fleetx-mcp-server
 ```
 
-| Command | Description |
-|---------|-------------|
-| `npm run dev` | Start with hot-reload (ts-node-dev) |
-| `npm run build` | Compile TypeScript to `dist/` |
-| `npm start` | Run compiled output |
-| `npm run startClient` | Launch with MCP Inspector (built) |
-| `npm run startClientLive` | Launch with MCP Inspector (live reload) |
-
-### Project Structure
-
-```
-src/
-  index.ts           Stdio transport entrypoint
-  mcpServer.ts       MCP server + login tool + dynamic tool registration
-  auth.ts            Login flow + in-memory token store
-  apiDiscovery.ts    Fetch API definitions from protected endpoint
-  toolGenerator.ts   Convert API definitions into MCP tools
-  proxyCaller.ts     Proxy calls to external APIs via Axios
-  schemaBuilder.ts   Zod schema + JSON Schema generation from API metadata
-  utils.ts           Logging + config helpers
-  types.ts           Shared TypeScript interfaces
-```
+This opens a web UI where you can connect, call `login`, browse all discovered tools, and test them interactively.
 
 ---
 
 ## Requirements
 
-- Node.js >= 16
-- npm or npx
+- Node.js >= 20
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fleetx_io/fleetx-mcp-server",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "MCP server that gives AI agents access to the FleetX REST API. Works with Cursor, Claude Desktop, Windsurf, and any MCP-compatible client.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,6 +8,7 @@
     "fleetx-mcp-server": "dist/index.js"
   },
   "files": [
+    "package.json",
     "dist",
     "README.md",
     "CHANGELOG.md",