Platform Documentation

https://docs.msty.ai/studio/
Admin
A documentation project providing guides and information on various features like agent mode, model...
Tokens:21,289
Snippets:433
Trust Score:8.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example MySQL Tool Configuration (JSON)

Source: https://docs.msty.ai/studio/toolbox/tools

This JSON configuration defines a tool for interacting with a MySQL database using the 'uv' command. It specifies the command, arguments including dynamic database paths, and environment variables for connection details. Ensure that 'uv' and 'mysql_mcp_server' are installed and accessible.

```json
{
  "command":"uv",
  "args": [
    "--directory",
    "{dbPath:Database Path:/path/to/database.db}",
    "run","mysql_mcp_server"
  ],
  "env":{
    "MYSQL_HOST":"{Database Host}",
    "MYSQL_PORT":"{Database Port}",
    "MYSQL_USER":"{Database User}",
    "MYSQL_PASS":"{Database Password}",
    "MYSQL_DB":"{Database Name}"
  }
}
```

--------------------------------

### Example Tailscale Serve URL

Source: https://docs.msty.ai/studio/how-tos/setup-tailscale-for-sidecar

This is an example of the URL provided by Tailscale Serve after successfully setting a path for a local service.

```text
Success.
Available within your tailnet:

https://<your machine identifier>.taile5baa0.ts.net/sidecar
|-- proxy http://127.0.0.1:11932

```

--------------------------------

### Example .mstyignore File

Source: https://docs.msty.ai/studio/knowledge-stacks/ignore-file

This example demonstrates common ignore patterns, including ignoring specific file types, folders, and negating certain files.

```gitignore
# Ignore all .log files
*.log

# Ignore the entire 'temp' folder
temp/

# Ignore all .tmp files in any directory
**/*.tmp

# Ignore all files in the 'drafts' folder
drafts/

# But don't ignore important drafts
!drafts/important_draft.md

# Ignore all files starting with 'temp_'
temp_*

# Ignore all files ending with '_old'
*_old

```

--------------------------------

### Install Python and uv on Windows using WinGet

Source: https://docs.msty.ai/studio/toolbox/tool-dependencies

Use WinGet to install Python 3.12 and uv on your Windows machine. Ensure you have WinGet installed first.

```bash
winget install -e --id Python.Python.3.12 --scope machine
winget install --id=astral-sh.uv  -e

```

--------------------------------

### Install Deb Package

Source: https://docs.msty.ai/studio/getting-started/download

To install the Msty Studio Desktop deb package on Linux, use this command with sudo privileges.

```bash
sudo apt install ./<DownloadedFileName>.deb
```

--------------------------------

### Launch Msty Studio Desktop from Deb

Source: https://docs.msty.ai/studio/getting-started/download

After installing the deb package, you can launch Msty Studio Desktop using this command.

```bash
MstyStudio
```

--------------------------------

### Example Tool Configuration for uvx

Source: https://docs.msty.ai/studio/toolbox/tool-dependencies

This JSON configuration is used to create a new tool that utilizes 'uvx' to manage Python packages. It demonstrates how to specify the command and its arguments.

```json
{
  "command": "uvx",
  "args": ["mcp-request"]
}

```

--------------------------------

### Check Node Installation Path

Source: https://docs.msty.ai/studio/toolbox/tools

This command helps identify the installation directory of the Node.js executable. This is useful for verifying Node.js installation and ensuring it's managed by a recommended package manager like Volta.

```bash
which node

```

--------------------------------

### Install Gemini CLI Agent

Source: https://docs.msty.ai/studio/agent-mode/agent-mode

Install the Gemini CLI agent globally using npm. This command requires Node.js and npm to be set up.

```bash
npm install -g @google/gemini-cli

```

--------------------------------

### Example Sidecar Connection URL

Source: https://docs.msty.ai/studio/how-tos/setup-tailscale-for-sidecar

Construct the final connection URL for Sidecar by combining the Tailscale Serve URL with the Sidecar token.

```text
https://<your machine identifier>.taile5baa0.ts.net/sidecar?token=<your token>

```

--------------------------------

### Fix Deb Installation Permission Issues (2/2)

Source: https://docs.msty.ai/studio/getting-started/download

Following the ownership change, run this command to set the correct permissions for the chrome-sandbox.

```bash
sudo chmod 4755 /opt/MstyStudio/chrome-sandbox
```

--------------------------------

### Install Codex CLI Agent

Source: https://docs.msty.ai/studio/agent-mode/agent-mode

Use this command to install the Codex CLI agent globally via npm. Ensure Node.js and npm are installed first.

```bash
npm install -g @openai/codex

```

--------------------------------

### Start Sidecar from Command Line

Source: https://docs.msty.ai/studio/how-tos/sidecar

Use this command to launch the Msty Sidecar application from your terminal. This can be useful for troubleshooting service detection issues.

```shell
open -a MstySidecar

```

--------------------------------

### Fix Deb Installation Permission Issues (1/2)

Source: https://docs.msty.ai/studio/getting-started/download

If the deb installation experiences permission issues, run this command to change ownership of the chrome-sandbox.

```bash
sudo chown root:root /opt/MstyStudio/chrome-sandbox
```

--------------------------------

### Install Claude Code CLI Agent

Source: https://docs.msty.ai/studio/agent-mode/agent-mode

Install the Claude Code CLI agent globally using npm. This command requires Node.js and npm.

```bash
npm install -g @anthropic-ai/claude-code

```

--------------------------------

### Get AWS STS Session Token

Source: https://docs.msty.ai/studio/how-tos/aws-bedrock

Use the AWS CLI to generate temporary session tokens for short-term API key access. Ensure you have the AWS CLI installed and configured.

```bash
aws sts get-session-token

```

--------------------------------

### Enable Tailscale Serve

Source: https://docs.msty.ai/studio/how-tos/setup-tailscale-for-sidecar

Run this command to enable Tailscale Serve, which allows proxying traffic to local services.

```bash
tailscale serve

```

--------------------------------

### Run AppImage

Source: https://docs.msty.ai/studio/getting-started/download

Once the AppImage is executable, you can run it using this command. The `--no-sandbox` flag may be necessary in some environments.

```bash
./<DownloadedFileName>.AppImage --no-sandbox
```

--------------------------------

### Configure Tool Use and Integration

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Manage tool integration by specifying enabled tools, confidence thresholds, and preferences. Auto-selection can streamline tool usage.

```json
{
  "toolConfig": {
    "enabledTools": ["calculator", "web_search", "code_execution"],
    "toolCallThreshold": 0.7, // Confidence threshold for tool calling (0.0-1.0)
    "maxToolCalls": 5, // Maximum number of tool calls per request
    "autoToolSelection": true, // Automatically select appropriate tools
    "toolPreferences": {
      "preferred": ["calculator"], // Tools to prioritize
      "fallback": ["web_search"] // Tools to use as fallback
    }
  }
}

```

--------------------------------

### Processing Function Example

Source: https://docs.msty.ai/studio/toolbox/live-contexts

This is a default processing function that stringifies the API response data. It's useful for ensuring the data is in a format that can be easily processed by the model.

```javascript
return JSON.stringify(data)
```

--------------------------------

### Memory and Context Configurations

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Configure how the model manages memory and context, including maximum tokens, retention strategy, compression, and prioritization.

```json
{
  "contextConfig": {
    "maxTokens": 128000, // Maximum context window size
    "retentionStrategy": "recency", // Options: "recency", "importance", "hybrid"
    "compressionRatio": 0.8, // Context compression ratio (0.0-1.0)
    "memoryOptimization": "auto", // Options: "auto", "aggressive", "conservative"
    "contextPrioritization": [
      // Priority order for context management
      "user_instructions",
      "recent_exchanges",
      "relevant_facts",
      "system_instructions"
    ]
  }
}

```

--------------------------------

### Run Gemini CLI Agent Once

Source: https://docs.msty.ai/studio/agent-mode/agent-mode

Run this command in your terminal to initiate the Gemini CLI agent. Follow the prompts to sign in with your Google account.

```bash
gemini

```

--------------------------------

### Configure Thinking and Reasoning

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Adjust thinking and reasoning configurations, including the thinking budget, depth, and strategy. Enable auto-thinking for complex queries.

```json
{
  "thinkingConfig": {
    "thinkingBudget": 0, // Disable thinking mode (0) or set custom budget (positive integer)
    "thinkingDepth": "deep", // Options: "shallow", "medium", "deep"
    "enableAutoThinking": false, // Auto-enable thinking for complex queries
    "thinkingStrategy": "structured", // Options: "structured", "exploratory", "critical"
    "reasoningEffort": "low", // Controls effort spent on reasoning
    "microstat": true // Enable fine-grained statistical reasoning
  }
}

```

--------------------------------

### Run AppImage with GTK 3

Source: https://docs.msty.ai/studio/getting-started/download

If you encounter issues with GTK versions, try running the AppImage with GTK 3 specified.

```bash
./MstyStudio_x86_64.AppImage --gtk-version=3
```

--------------------------------

### Multimodal Configurations

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Enable and configure multimodal capabilities such as vision, image analysis, and audio/video processing.

```json
{
  "multimodalConfig": {
    "visionEnabled": true, // Enable vision capabilities
    "imageAnalysisDetail": "high", // Options: "low", "medium", "high"
    "imageGenerationEnabled": false, // Enable image generation
    "audioProcessingEnabled": false, // Enable audio processing
    "videoAnalysisEnabled": false, // Enable video analysis
    "modalityPreference": "balanced" // Options: "text", "visual", "balanced"
  }
}

```

--------------------------------

### Advanced Runtime Configurations

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Configure runtime behavior including priority, timeouts, retries, streaming, caching, quota management, and logging.

```json
{
  "runtimeConfig": {
    "priority": "standard", // Options: "low", "standard", "high"
    "timeout": 60000, // Request timeout in milliseconds
    "maxRetries": 3, // Maximum retry attempts
    "stream": true, // Enable streaming responses
    "streamChunkSize": 16, // Number of tokens per streaming chunk
    "streamLatency": "low", // Options: "low", "balanced", "consistent"
    "caching": {
      "enabled": true, // Enable response caching
      "ttl": 3600 // Cache time-to-live in seconds
    },
    "quotaManagement": {
      "tokensPerMinute": 10000, // Rate limit for tokens
      "requestsPerDay": 1000 // Daily request limit
    },
    "logging": {
      "level": "info", // Options: "debug", "info", "warn", "error"
      "includePrompts": false, // Include prompts in logs
      "includeResponses": false // Include responses in logs
    }
  }
}

```

--------------------------------

### Output Formatting Configurations

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Control the format, verbosity, structure, and language style of the model's output.

```json
{
  "outputConfig": {
    "responseFormat": "markdown", // Options: "markdown", "plain", "json", "xml", "html"
    "verbosityLevel": "concise", // Options: "minimal", "concise", "detailed", "comprehensive"
    "structurePreference": "narrative", // Options: "narrative", "analytical", "bullet", "dialog"
    "citationStyle": "academic", // Options: "none", "informal", "academic", "legal"
    "languageModel": "formal", // Options: "casual", "formal", "technical", "creative"
    "maxOutputTokens": 4096 // Maximum response length
  }
}

```

--------------------------------

### Make AppImage Executable

Source: https://docs.msty.ai/studio/getting-started/download

After downloading the AppImage for Linux, use this command in your terminal to make it executable.

```bash
chmod a+x ./<DownloadedFileName>.AppImage
```

--------------------------------

### Configure System Behavior

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Set system behavior parameters like personality, roleplay mode, expertise domains, and conversational style. Use these to tailor the AI's interaction style.

```json
{
  "behaviorConfig": {
    "personality": "helpful", // Options: "helpful", "concise", "creative", "analytical"
    "roleplayMode": false, // Enable character roleplay capabilities
    "expertiseDomains": ["coding", "science", "math"],
    "conversationalStyle": "balanced", // Options: "formal", "casual", "balanced", "technical"
    "initiativeLevel": "responsive", // Options: "passive", "responsive", "proactive"
    "opinionExpression": "neutral", // Options: "neutral", "balanced", "opinionated"
    "uncertaintyHandling": "transparent" // Options: "confident", "transparent", "conservative"
  }
}

```

--------------------------------

### Run Codex CLI Agent Once

Source: https://docs.msty.ai/studio/agent-mode/agent-mode

Execute this command in your terminal to run the Codex CLI agent for the first time. This is required for the sign-in process.

```bash
codex

```

--------------------------------

### Sampling Configurations

Source: https://docs.msty.ai/studio/managing-models/advanced-configs

Control the sampling process to influence output randomness, creativity, and reproducibility.

```json
{
  "samplingConfig": {
    "temperature": 0.7, // Controls randomness (0.0-1.0)
    "top_p": 0.9, // Nucleus sampling parameter (0.0-1.0)
    "top_k": 40, // Limits vocabulary to top K tokens
    "frequencyPenalty": 0.5, // Penalizes repetition (0.0-2.0)
    "presencePenalty": 0.5, // Penalizes token reuse (0.0-2.0)
    "deterministicSampling": false, // Forces deterministic outputs
    "seed": 123456 // Random seed for reproducibility
  }
}

```

--------------------------------

### Ignore Files by Extension

Source: https://docs.msty.ai/studio/knowledge-stacks/ignore-file

Use a wildcard to ignore all files with a specific extension.

```gitignore
*.log
```
Tokens:
Raw