@mtaap/mcp 0.2.13 → 0.5.1

package/dist/index.d.ts

@@ -11,10 +11,19 @@ import { TaskState, ErrorType } from '@mtaap/core';
 
 /**
  * API Client Configuration
+ *
+ * Supports two authentication methods:
+ * - apiKey: Traditional API key authentication (X-API-Key header)
+ * - oauthToken: OAuth 2.0 Bearer token (Authorization header)
+ *
+ * At least one authentication method must be provided.
  */
 interface ApiClientConfig {
     baseUrl: string;
-    apiKey: string;
+    /** API key for X-API-Key authentication */
+    apiKey?: string;
+    /** OAuth access token for Bearer authentication */
+    oauthToken?: string;
     timeout?: number;
     debug?: boolean;
 }
@@ -23,8 +32,9 @@ interface ApiClientConfig {
  */
 interface AuthContext {
     userId: string;
-    organizationId: string | undefined;
-    permissions: string[];
+    organizationId?: string;
+    /** Permission level: "READ" | "WRITE" | "ADMIN" for OAuth, or string[] for API keys */
+    permissions: string | string[];
     userName: string;
     userEmail: string;
 }
@@ -84,6 +94,8 @@ interface Task {
         message: string;
         checkpoints: string[];
         userId: string;
+        apiKeyNickname: string | null;
+        createdVia: "UI" | "API_KEY" | "OAUTH";
         createdAt: string;
     }>;
     notes?: Array<{
@@ -91,6 +103,8 @@ interface Task {
         content: string;
         userId: string;
         userName: string | null;
+        apiKeyNickname: string | null;
+        createdVia: "UI" | "API_KEY" | "OAUTH";
         createdAt: string;
     }>;
     createdAt: string;
@@ -124,21 +138,40 @@ declare class ApiError extends Error {
     status: number;
     details?: Record<string, unknown> | undefined;
     constructor(message: string, code: string, status: number, details?: Record<string, unknown> | undefined);
+    /**
+     * Whether this error is transient and the request can be retried.
+     * Retries on network errors (status 0), timeouts (408), and server errors (5xx).
+     */
+    get isRetryable(): boolean;
 }
 /**
  * MCP API Client
  */
 declare class MCPApiClient {
     private baseUrl;
-    private apiKey;
+    private apiKey?;
+    private oauthToken?;
     private timeout;
     private debug;
     private authContext;
+    private cache;
     constructor(config: ApiClientConfig);
     /**
-     * Make an HTTP request to the API
+     * Get a cached value if it exists and hasn't expired.
+     */
+    private getCached;
+    /**
+     * Store a value in cache with a TTL.
+     */
+    private setCache;
+    /**
+     * Make an HTTP request to the API with automatic retry on transient failures.
      */
     private request;
+    /**
+     * Execute a single HTTP request to the API.
+     */
+    private requestOnce;
     /**
      * Authenticate and get user context
      */
@@ -148,7 +181,7 @@ declare class MCPApiClient {
      */
     getAuthContext(): Promise<AuthContext>;
     /**
-     * List accessible projects
+     * List accessible projects (cached for 30s)
      */
     listProjects(workspaceType?: string): Promise<Project[]>;
     /**
@@ -156,7 +189,7 @@ declare class MCPApiClient {
      */
     getProject(projectId: string): Promise<Project>;
     /**
-     * Get project context (README, stack, conventions)
+     * Get project context (README, stack, conventions) (cached for 60s)
      */
     getProjectContext(projectId: string): Promise<ProjectContext>;
     /**
@@ -330,7 +363,8 @@ declare class MCPApiClient {
         prompt: string;
     }>;
     /**
-     * Update task details (DRAFT/TODO states only)
+     * Update task details (DRAFT/TODO states only).
+     * Task stays in its current state.
      */
     updateTask(taskId: string, projectId: string, data: {
         title?: string;
@@ -340,27 +374,7 @@ declare class MCPApiClient {
             id?: string;
             description: string;
         }>;
-    }): Promise<{
-        success: boolean;
-        taskId: string;
-        previousState: string;
-        newState: string;
-        revertedToDraft: boolean;
-        message: string;
-        task: {
-            id: string;
-            title: string;
-            description: string;
-            priority: string;
-            state: string;
-            verificationStatus: string;
-            acceptanceCriteria: Array<{
-                id: string;
-                description: string;
-                order: number;
-            }>;
-        };
-    }>;
+    }): Promise<Record<string, unknown>>;
 }
 
 declare const VERSION: string;