@mindstudio-ai/agent 0.1.0 → 0.1.3

package/llms.txt

@@ -1,11 +1,33 @@
 # @mindstudio-ai/agent
 
-TypeScript SDK, CLI, and MCP server for MindStudio. One API key gives you access to 200+ AI models (OpenAI, Anthropic, Google, Meta, xAI, DeepSeek, etc.) and 1,000+ integrations including 850+ third-party connectors from the open-source MindStudio Connector Registry (https://github.com/mindstudio-ai/mscr). No separate provider API keys required.
+TypeScript SDK, CLI, and MCP server for MindStudio. One API key gives you access to 200+ AI models (OpenAI, Anthropic, Google, Meta, xAI, DeepSeek, etc.) and 1,000+ actions including 850+ connector actions across third-party services from the open-source MindStudio Connector Registry (https://github.com/mindstudio-ai/mscr). No separate provider API keys required.
 
 This file is the complete API reference. No other documentation is needed to use the SDK.
 
+## Recommended workflow
+
+There are 150+ methods available. Do NOT try to read or load them all at once. Follow this discovery flow:
+
+1. **Identify yourself** — Call `changeName` to set your display name (use your name or whatever your user calls you). If you have a profile picture or icon, call `uploadFile` to upload it, then `changeProfilePicture` with the returned URL. This helps users identify your requests in their logs.
+2. **Discover** — Call `listSteps` (MCP tool) or `mindstudio list --summary` (CLI) to get a compact `{ method: description }` map of everything available (~3k tokens).
+3. **Drill in** — Once you identify the right method, look up its full signature in the Methods reference below, or call `mindstudio info <method>` (CLI) for parameter details.
+4. **Call it** — Invoke the method with the required parameters. All step methods share the same calling convention (see below).
+
+For specific use cases:
+
+- **Third-party integrations** (Slack, Google, HubSpot, etc.): Call `listConnectors()` to browse services → `getConnectorAction(serviceId, actionId)` for input fields → execute via `runFromConnectorRegistry`. Requires an OAuth connection set up in MindStudio first — call `listConnections()` to check available connections.
+- **Pre-built agents**: Call `listAgents()` to see what's available → `runAgent({ appId })` to execute one. Agents are full workflows built in MindStudio — they can combine multiple steps, have custom logic, and maintain their own state.
+- **Model selection**: Call `listModelsSummary()` or `listModelsSummaryByType("llm_chat")` to browse models, then pass the model ID as `modelOverride.model` to methods like `generateText`. Use the summary endpoints (not `listModels`) to keep token usage low.
+- **Cost estimation**: Call `estimateStepCost(stepType, stepInput)` before expensive calls to preview pricing.
+
 ## Install
 
+Standalone binary (CLI/MCP, no dependencies):
+```bash
+curl -fsSL https://msagent.ai/install.sh | bash
+```
+
+npm (SDK + CLI):
 ```bash
 npm install @mindstudio-ai/agent
 ```
@@ -26,7 +48,10 @@ mindstudio generate-image '{prompt: "A mountain landscape"}'
 # Extract a single output field
 mindstudio generate-image --prompt "A sunset" --output-key imageUrl
 
-# List all available methods
+# List all methods (compact JSON — best for LLM discovery)
+mindstudio list --summary
+
+# List all methods (human-readable table)
 mindstudio list
 
 # Show method details (params, types, output)
@@ -57,19 +82,19 @@ Auth resolution order: `--api-key` flag > `MINDSTUDIO_API_KEY` env > `~/.mindstu
 
 ## MCP server
 
-The package includes an MCP server exposing all methods as tools:
+The package includes an MCP server exposing all methods as tools. Start by calling the `listSteps` tool to discover available methods.
 
 ```bash
 mindstudio mcp
 ```
 
-MCP client config:
+MCP client config (standalone binary — recommended):
 ```json
 {
   "mcpServers": {
     "mindstudio": {
-      "command": "npx",
-      "args": ["-y", "@mindstudio-ai/agent", "mcp"],
+      "command": "mindstudio",
+      "args": ["mcp"],
       "env": { "MINDSTUDIO_API_KEY": "your-api-key" }
     }
   }
@@ -227,6 +252,14 @@ Create a new empty vector data source for the current app.
 - Input: `{ name: string }`
 - Output: `unknown`
 
+#### createGmailDraft
+Create a draft email in the connected Gmail account.
+- Requires a Google OAuth connection with Gmail compose scope.
+- The draft appears in the user's Gmail Drafts folder but is not sent.
+- messageType controls the body format: "plain" for plain text, "html" for raw HTML, "markdown" for auto-converted markdown.
+- Input: `{ to: string, subject: string, message: string, connectionId?: string, messageType: "plain" | "html" | "markdown" }`
+- Output: `{ draftId: string }`
+
 #### deleteDataSource
 Delete a vector data source from the current app.
 - Soft-deletes a data source (vector database) by marking it as deleted.
@@ -408,6 +441,23 @@ Generate a video from a text prompt using an AI model.
 - Input: `{ prompt: string, skipAssetCreation?: boolean, videoModelOverride?: { model: string, config?: object }, generateVariants?: boolean, numVariants?: number, addWatermark?: boolean }`
 - Output: `{ videoUrl: string | string[] }`
 
+#### getGmailAttachments
+Download attachments from a Gmail email and re-host them on CDN.
+- Requires a Google OAuth connection with Gmail readonly scope.
+- Attachments are uploaded to CDN and returned as URLs.
+- Attachments larger than 25MB are skipped.
+- Use the message ID from Search Gmail Emails, List Recent Gmail Emails, or Get Gmail Email steps.
+- Input: `{ messageId: string, connectionId?: string }`
+- Output: `unknown`
+
+#### getGmailUnreadCount
+Get the number of unread emails in the connected Gmail inbox.
+- Requires a Google OAuth connection with Gmail readonly scope.
+- Returns the unread message count for the inbox label.
+- This is a lightweight call that does not fetch any email content.
+- Input: `{ connectionId?: string }`
+- Output: `unknown`
+
 #### getMediaMetadata
 Get info about a media file
 - Input: `{ mediaUrl: string }`
@@ -445,6 +495,22 @@ List all data sources for the current app.
 - Input: `object`
 - Output: `unknown`
 
+#### listGmailLabels
+List all labels in the connected Gmail account. Use these label IDs or names with the Update Gmail Labels step.
+- Requires a Google OAuth connection with Gmail readonly scope.
+- Returns both system labels (INBOX, SENT, TRASH, etc.) and user-created labels.
+- Label type is "system" for built-in labels or "user" for custom labels.
+- Input: `{ connectionId?: string }`
+- Output: `unknown`
+
+#### listRecentGmailEmails
+List recent emails from the connected Gmail inbox.
+- Requires a Google OAuth connection with Gmail readonly scope.
+- Returns up to 100 emails (default 5), ordered by most recent first.
+- Functionally equivalent to Search Gmail Emails with an "in:inbox" query.
+- Input: `{ connectionId?: string, exportType: "json" | "text", limit: string }`
+- Output: `unknown`
+
 #### logic
 Route execution to different branches based on AI evaluation, comparison operators, or workflow jumps.
 - Supports two modes: "ai" (default) uses an AI model to pick the most accurate statement; "comparison" uses operator-based checks.
@@ -595,6 +661,16 @@ Scrape public profile data from an X (Twitter) account by URL.
 - Input: `{ url: string }`
 - Output: `{ profile: { text: string, html: string, json?: object, screenshotUrl?: string, metadata?: { title: string, description: string, url: string, image: string } } }`
 
+#### searchGmailEmails
+Search for emails in the connected Gmail account using a Gmail search query. To list recent inbox emails, pass an empty query string.
+- Requires a Google OAuth connection with Gmail readonly scope.
+- Uses Gmail search syntax (e.g. "from:user@example.com", "subject:invoice", "is:unread").
+- To list recent inbox emails, use an empty query string or "in:inbox".
+- Returns up to 100 emails (default 5). The variable receives text or JSON depending on exportType.
+- The direct execution output always returns structured email objects.
+- Input: `{ query: string, connectionId?: string, exportType: "json" | "text", limit: string }`
+- Output: `{ emails: { id: string, subject: string, from: string, to: string, date: string, plainBody: string, htmlBody: string, labels: string }[] }`
+
 #### searchGoogle
 Search the web using Google and return structured results.
 - Defaults to us/english, but can optionally specify country and/or language.
@@ -642,6 +718,21 @@ Send an email to one or more configured recipient addresses.
 - Input: `{ subject: string, body: string, connectionId?: string, generateHtml?: boolean, generateHtmlInstructions?: string, generateHtmlModelOverride?: { model: string, temperature: number, maxResponseTokens: number, ignorePreamble?: boolean, userMessagePreprocessor?: { dataSource?: string, messageTemplate?: string, maxResults?: number, enabled?: boolean, shouldInherit?: boolean }, preamble?: string, multiModelEnabled?: boolean, editResponseEnabled?: boolean, config?: object }, attachments?: string[] }`
 - Output: `{ recipients: string[] }`
 
+#### sendGmailDraft
+Send an existing draft from the connected Gmail account.
+- Requires a Google OAuth connection with Gmail compose scope.
+- The draft is sent and removed from the Drafts folder.
+- Use the draft ID returned by the Create Gmail Draft or List Gmail Drafts steps.
+- Input: `{ draftId: string, connectionId?: string }`
+- Output: `unknown`
+
+#### sendGmailMessage
+Send an email from the connected Gmail account.
+- Requires a Google OAuth connection with Gmail compose scope.
+- messageType controls the body format: "plain" for plain text, "html" for raw HTML, "markdown" for auto-converted markdown.
+- Input: `{ to: string, subject: string, message: string, connectionId?: string, messageType: "plain" | "html" | "markdown" }`
+- Output: `{ messageId: string }`
+
 #### sendSMS
 Send an SMS or MMS message to a phone number configured via OAuth connection.
 - User is responsible for configuring the connection to the number (MindStudio requires double opt-in to prevent spam)
@@ -651,6 +742,14 @@ Send an SMS or MMS message to a phone number configured via OAuth connection.
 - Input: `{ body: string, connectionId?: string, mediaUrls?: string[] }`
 - Output: `unknown`
 
+#### setGmailReadStatus
+Mark one or more Gmail emails as read or unread.
+- Requires a Google OAuth connection with Gmail modify scope.
+- Accepts one or more message IDs as a comma-separated string or array.
+- Set markAsRead to true to mark as read, false to mark as unread.
+- Input: `{ messageIds: string, markAsRead: boolean, connectionId?: string }`
+- Output: `unknown`
+
 #### setRunTitle
 Set the title of the agent run for the user's history
 - Input: `{ title: string }`
@@ -733,6 +832,14 @@ Trim an audio or video clip
 - Input: `{ inputUrl: string, start?: number | string, duration?: string | number, skipAssetCreation?: boolean }`
 - Output: `{ mediaUrl: string }`
 
+#### updateGmailLabels
+Add or remove labels on Gmail messages, identified by message IDs or a search query.
+- Requires a Google OAuth connection with Gmail modify scope.
+- Provide either a query (Gmail search syntax) or explicit messageIds to target messages.
+- Label IDs can be label names or Gmail label IDs — names are resolved automatically.
+- Input: `{ query: string, connectionId?: string, messageIds: string, addLabelIds: string, removeLabelIds: string }`
+- Output: `{ updatedMessageIds: string[] }`
+
 #### uploadDataSourceDocument
 Upload a file into an existing data source from a URL or raw text content.
 - If "file" is a single URL, the file is downloaded from that URL and uploaded.
@@ -1366,7 +1473,7 @@ Output:
 ```
 
 #### `getConnectorAction(serviceId, actionId)`
-Get the full configuration for a connector action, including all input fields needed to call it via `runFromConnectorRegistry`. Connectors are sourced from the open-source MindStudio Connector Registry (MSCR) with 850+ third-party service integrations.
+Get the full configuration for a connector action, including all input fields needed to call it via `runFromConnectorRegistry`. Connectors are sourced from the open-source MindStudio Connector Registry (MSCR) with 850+ connector actions across third-party services.
 
 Output:
 ```typescript
@@ -1394,3 +1501,57 @@ Output:
   }[]
 }
 ```
+
+#### `estimateStepCost(stepType, step?, options?)`
+Estimate the cost of executing a step before running it. Pass the same step config you would use for execution.
+
+```typescript
+const estimate = await agent.estimateStepCost('generateText', { message: 'Hello' });
+```
+
+- `stepType`: string — The step method name (e.g. `"generateText"`).
+- `step`: object — Optional step input parameters for more accurate estimates.
+- `options`: `{ appId?: string, workflowId?: string }` — Optional context for pricing.
+
+Output:
+```typescript
+{
+  costType?: string;  // "free" when the step has no cost
+  estimates?: {
+    eventType: string;       // Billing event type
+    label: string;           // Human-readable cost label
+    unitPrice: number;       // Price per unit in billing units
+    unitType: string;        // What constitutes a unit (e.g. "token", "request")
+    estimatedCost?: number;  // Estimated total cost, or null if not estimable
+    quantity: number;        // Number of billable units
+  }[]
+}
+```
+
+#### `changeName(displayName)`
+Update the display name of the authenticated agent. Useful for agents to set their own name after connecting.
+
+```typescript
+await agent.changeName('My Agent');
+```
+
+#### `changeProfilePicture(profilePictureUrl)`
+Update the profile picture of the authenticated agent. Useful for agents to set their own avatar after connecting.
+
+```typescript
+await agent.changeProfilePicture('https://example.com/avatar.png');
+```
+
+#### `uploadFile(content, options)`
+Upload a file to the MindStudio CDN. Gets a signed upload URL, PUTs the file content, and returns the permanent public URL.
+
+```typescript
+import { readFileSync } from 'fs';
+const { url } = await agent.uploadFile(readFileSync('photo.png'), { extension: 'png', type: 'image/png' });
+```
+
+- `content`: `Buffer | Uint8Array` — The file content.
+- `options.extension`: string — File extension without the dot (e.g. `"png"`, `"jpg"`, `"mp4"`).
+- `options.type`: string (optional) — MIME type (e.g. `"image/png"`). Determines which CDN subdomain is used.
+
+Output: `{ url: string }` — The permanent public CDN URL.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindstudio-ai/agent",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "TypeScript SDK for MindStudio direct step execution",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,6 +25,7 @@
     "dev": "tsup --watch",
     "codegen": "tsx scripts/codegen.ts",
     "typecheck": "tsc --noEmit",
+    "postinstall": "node dist/postinstall.js || true",
     "prepare": "npm run build",
     "prepublishOnly": "npm run build"
   },