mcp-user-system 1.0.5 → 2.0.2

package/README.md

@@ -1,13 +1,15 @@
 # mcp-user-system
 
-[MCP](https://modelcontextprotocol.io) server for token-user-system — OpenAPI operations via Model Context Protocol.
+[MCP](https://modelcontextprotocol.io) server for token-user-system — Console 前台全量查询接口 via Model Context Protocol.
 
-Supports: wallet overview, dashboard stats, orders, users, model stats, trend.
+Provides AI agents with authenticated access to the Console (前台) query APIs, covering user info, dashboard statistics, wallet, team management, token usage, invoices, and miscellaneous lookups.
+
+Supports: user profiles, dashboard stats & trends, wallet overview, team & member management, token consumption, invoice queries, and more.
 
 ## Prerequisites
 
 - Node.js >= 18
-- `TUS_BASE_URL` and `TUS_API_KEY` environment variables
+- `TUS_BASE_URL` and `TUS_ACCESS_TOKEN` environment variables
 
 ## Installation
 
@@ -30,16 +32,18 @@ npm run build
 
 ```bash
 export TUS_BASE_URL=https://api.example.com
-export TUS_API_KEY=your-openapi-key
+export TUS_ACCESS_TOKEN=your-jwt-access-token
 ```
 
 Or create a `.env` file (add to `.gitignore`):
 
 ```bash
 TUS_BASE_URL=https://api.example.com
-TUS_API_KEY=your-openapi-key
+TUS_ACCESS_TOKEN=your-jwt-access-token
 ```
 
+> **Access Token** is a JWT Bearer Token obtained after user login. Include it as `Authorization: Bearer <token>` in upstream requests.
+
 ### 3. Test Run
 
 ```bash
@@ -60,7 +64,7 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
       "args": ["/path/to/mcp-user-system/dist/index.js"],
       "env": {
         "TUS_BASE_URL": "https://api.example.com",
-        "TUS_API_KEY": "your-openapi-key"
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
       }
     }
   }
@@ -79,7 +83,7 @@ Add to settings (Cursor: `~/.cursor/mcp.json`, VS Code: settings.json):
       "args": ["/path/to/mcp-user-system/dist/index.js"],
       "env": {
         "TUS_BASE_URL": "https://api.example.com",
-        "TUS_API_KEY": "your-openapi-key"
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
       }
     }
   }
@@ -98,7 +102,7 @@ Add to `~/.claude/mcp.json`:
       "args": ["/path/to/mcp-user-system/dist/index.js"],
       "env": {
         "TUS_BASE_URL": "https://api.example.com",
-        "TUS_API_KEY": "your-openapi-key"
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
       }
     }
   }
@@ -107,14 +111,161 @@ Add to `~/.claude/mcp.json`:
 
 ## Available Tools
 
-| Tool | Description |
-|------|-------------|
-| `wallet_overview` | Get account wallet overview (balance, usable balance, voucher, credit limit, pending amount) |
-| `dashboard_stats` | Get dashboard statistics (used quota, consumption, request count, active users, etc.) |
-| `dashboard_orders` | List API call detail records with optional filters |
-| `dashboard_users` | Get user dropdown options for dashboard filtering |
-| `dashboard_model_stats` | Get model usage statistics (call count, token consumption, cost, etc.) |
-| `dashboard_trend` | Get consumption trend data over time |
+**62 tools** organized by domain:
+
+| Domain | Count | Description |
+|--------|-------|-------------|
+| **user** | 6 | User profile, preferences, and account info |
+| **dashboard** | 10 | Dashboard statistics, trends, rankings, model usage, member usage |
+| **wallet** | 8 | Wallet overview, transactions, balance history, recharge records |
+| **team** | 14 | Team/department management, member CRUD, role & permission queries |
+| **tokens** | 6 | Token consumption details, usage aggregation, billing records |
+| **invoice** | 4 | Invoice list, invoice detail, red-punch status queries |
+| **misc** | 14 | Refund management, resource rules, alert settings, message center |
+
+## Authentication
+
+This MCP server uses **Access Token** (JWT Bearer Token) authentication. The token is obtained after user login and passed via the `TUS_ACCESS_TOKEN` environment variable. All upstream API requests include it as `Authorization: Bearer <token>`.
+
+## Development
+
+```bash
+npm run dev      # Watch mode
+npm run build    # Compile TypeScript
+npm start        # Run compiled server
+```
+
+## License
+
+MIT
+# mcp-user-system
+
+[MCP](https://modelcontextprotocol.io) server for token-user-system — Console 前台全量查询接口 via Model Context Protocol.
+
+Provides AI agents with authenticated access to the Console (前台) query APIs, covering user info, dashboard statistics, wallet, team management, token usage, invoices, and miscellaneous lookups.
+
+Supports: user profiles, dashboard stats & trends, wallet overview, team & member management, token consumption, invoice queries, and more.
+
+## Prerequisites
+
+- Node.js >= 18
+- `TUS_BASE_URL` and `TUS_ACCESS_TOKEN` environment variables
+
+## Installation
+
+### 1. Install globally
+
+```bash
+npm install -g mcp-user-system
+```
+
+Or clone & build manually:
+
+```bash
+git clone https://github.com/shenda-ai/mcp-user-system.git
+cd mcp-user-system
+npm install
+npm run build
+```
+
+### 2. Configure Environment
+
+```bash
+export TUS_BASE_URL=https://api.example.com
+export TUS_ACCESS_TOKEN=your-jwt-access-token
+```
+
+Or create a `.env` file (add to `.gitignore`):
+
+```bash
+TUS_BASE_URL=https://api.example.com
+TUS_ACCESS_TOKEN=your-jwt-access-token
+```
+
+> **Access Token** is a JWT Bearer Token obtained after user login. Include it as `Authorization: Bearer <token>` in upstream requests.
+
+### 3. Test Run
+
+```bash
+npm start
+```
+
+## MCP Client Configuration
+
+### Claude Desktop (macOS)
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "user-system": {
+      "command": "node",
+      "args": ["/path/to/mcp-user-system/dist/index.js"],
+      "env": {
+        "TUS_BASE_URL": "https://api.example.com",
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
+      }
+    }
+  }
+}
+```
+
+### Cursor / VS Code
+
+Add to settings (Cursor: `~/.cursor/mcp.json`, VS Code: settings.json):
+
+```json
+{
+  "mcpServers": {
+    "user-system": {
+      "command": "node",
+      "args": ["/path/to/mcp-user-system/dist/index.js"],
+      "env": {
+        "TUS_BASE_URL": "https://api.example.com",
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
+      }
+    }
+  }
+}
+```
+
+### Claude Code (CLI)
+
+Add to `~/.claude/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "user-system": {
+      "command": "node",
+      "args": ["/path/to/mcp-user-system/dist/index.js"],
+      "env": {
+        "TUS_BASE_URL": "https://api.example.com",
+        "TUS_ACCESS_TOKEN": "your-jwt-access-token"
+      }
+    }
+  }
+}
+```
+
+## Available Tools
+
+**62 tools** organized by domain:
+
+| Domain | Count | Description |
+|--------|-------|-------------|
+| **user** | 6 | User profile, preferences, and account info |
+| **dashboard** | 10 | Dashboard statistics, trends, rankings, model usage, member usage |
+| **wallet** | 8 | Wallet overview, transactions, balance history, recharge records |
+| **team** | 14 | Team/department management, member CRUD, role & permission queries |
+| **tokens** | 6 | Token consumption details, usage aggregation, billing records |
+| **invoice** | 4 | Invoice list, invoice detail, red-punch status queries |
+| **misc** | 14 | Model list, announcements, notifications, system config, and other lookups |
+
+## Authentication
+
+This MCP server uses **Access Token** (JWT Bearer Token) authentication. The token is obtained after user login and passed via the `TUS_ACCESS_TOKEN` environment variable. All upstream API requests include it as `Authorization: Bearer <token>`.
 
 ## Development
 

package/dist/env.d.ts

@@ -3,6 +3,6 @@
  */
 export interface Config {
     baseUrl: string;
-    apiKey: string;
+    accessToken: string;
 }
 export declare function loadConfig(): Config;

package/dist/env.js

@@ -11,7 +11,7 @@ function requireEnv(name) {
 export function loadConfig() {
     return {
         baseUrl: requireEnv("TUS_BASE_URL"),
-        apiKey: requireEnv("TUS_API_KEY"),
+        accessToken: requireEnv("TUS_ACCESS_TOKEN"),
     };
 }
 //# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -1 +1 @@
-{"version":3,"file":"env.js","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,cAAc,CAAC;QACnC,MAAM,EAAE,UAAU,CAAC,aAAa,CAAC;KAClC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,cAAc,CAAC;QACnC,WAAW,EAAE,UAAU,CAAC,kBAAkB,CAAC;KAC5C,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -2,8 +2,7 @@
 /**
  * MCP Server for token-user-system
  *
- * Provides OpenAPI tools via Model Context Protocol.
- * Supports: wallet, dashboard stats, orders, users, model-stats, trend,
- *           configurable-models, tokens-list, tokens-list-page, team-tree, team-members
+ * Provides tools via Model Context Protocol, organized by domain:
+ * user, dashboard, wallet, team, tokens, invoice, misc
  */
 export {};