@mindstudio-ai/agent 0.1.1 → 0.1.4

package/llms.txt

@@ -8,19 +8,26 @@ This file is the complete API reference. No other documentation is needed to use
 
 There are 150+ methods available. Do NOT try to read or load them all at once. Follow this discovery flow:
 
-1. **Discover** — Call `listSteps` (MCP tool) or `mindstudio list --summary` (CLI) to get a compact `{ method: description }` map of everything available (~3k tokens).
-2. **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.
-3. **Call it** — Invoke the method with the required parameters. All step methods share the same calling convention (see below).
+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.
+- **Pre-built agents**: Call `listAgents()` to see what's available → `runAgent({ appId })` to execute one. **Important:** Not all agents are configured for API use. Do not try to run an agent just because it appears in the list — only run agents the user specifically asks you to run.
 - **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.
+- **Cost estimation**: AI-powered steps (text generation, image generation, video, audio, etc.) cost money. Call `estimateStepCost(stepType, stepInput)` before running these and confirm with the user before proceeding — unless they've explicitly given permission to go ahead. Non-AI steps (data lookups, connectors, etc.) are generally free.
 
 ## 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
 ```
@@ -81,13 +88,13 @@ The package includes an MCP server exposing all methods as tools. Start by calli
 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" }
     }
   }
@@ -1520,3 +1527,31 @@ Output:
   }[]
 }
 ```
+
+#### `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.1",
+  "version": "0.1.4",
   "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"
   },