Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloud.vessl.ai/llms.txt

Use this file to discover all available pages before exploring further.

There are two complementary ways to connect VESSL Cloud to AI coding tools. Install the vesslctl skill so your agent can create workspaces, submit jobs, and manage volumes on your behalf. Connect the MCP server so your agent can look up commands, flags, and workflows directly from the docs while you work.

Install the vesslctl skill

The vesslctl skill command installs a bundled skill file that teaches AI coding agents (such as Claude Code, Codex, Gemini CLI, and Cursor) how to operate VESSL Cloud through vesslctl. Skills follow the Agent Skills open standard. Run it interactively and pick a target:
vesslctl skill install
Available targets:
TargetDefault directoryWorks with
cross-client~/.agents/skillsCodex, Gemini CLI, Cursor, and other Agent-Skills-compatible agents
claude-code~/.claude/skillsClaude Code (native)
Non-interactive install:
vesslctl skill install --target claude-code
vesslctl skill install --target cross-client
vesslctl skill install --dir ~/my-skills
The command is idempotent — re-running it skips files that are already up to date. Once the skill is installed, the agent can act on VESSL Cloud without any further prompting. Try:
Create a GPU workspace on VESSL Cloud
For the full flag reference and the skill show subcommand, see vesslctl skill.

Connect the docs through MCP

Give your AI tool live access to VESSL Cloud docs so it can look up commands, flags, and workflows while you work. Connect this URL to any MCP-compatible AI tool:
https://docs.cloud.vessl.ai/mcp
The server exposes two tools:
ToolDescription
search_vessl_aiSearch across all VESSL Cloud documentation for relevant content
query_docs_filesystem_vessl_aiRun shell-like commands (rg, grep, cat, head, tree, ls) on a virtual filesystem of VESSL Cloud docs to inspect structure and read specific pages

Claude Code

Add the MCP server to your project’s CLAUDE.md or Claude Code settings:
{
  "mcpServers": {
    "vessl-docs": {
      "type": "url",
      "url": "https://docs.cloud.vessl.ai/mcp"
    }
  }
}
Once connected, Claude Code can look up vesslctl commands, check available flags, and reference common workflows while helping you write scripts or debug issues.

Example CLAUDE.md for vesslctl projects

# Project Setup

This project uses VESSL Cloud for GPU workloads.

## Tools
- `vesslctl` CLI for managing workspaces and batch jobs
- VESSL docs available through MCP at https://docs.cloud.vessl.ai/mcp

## Common tasks
- Create workspace: `vesslctl workspace create --name <name> --resource-spec <spec> --image <image>`
- Submit batch job: `vesslctl job create --name <name> --resource-spec <spec> --image <image> --cmd "<command>"`
- Check job logs: `vesslctl job logs <slug> --follow`

Cursor

  1. Open Settings
  2. Go to MCP Servers
  3. Add a new server with URL: https://docs.cloud.vessl.ai/mcp

Windsurf

  1. Open Settings
  2. Navigate to Cascade > MCP
  3. Add a new MCP server with URL: https://docs.cloud.vessl.ai/mcp

VS Code (with Copilot or Continue)

Add to your .vscode/mcp.json:
{
  "servers": {
    "vessl-docs": {
      "type": "url",
      "url": "https://docs.cloud.vessl.ai/mcp"
    }
  }
}

Other tools

Any tool that supports MCP can connect using the server URL. Check your tool’s documentation for how to add an MCP server, then use:
https://docs.cloud.vessl.ai/mcp
Each page in the VESSL Cloud docs has a Copy MCP link option in the context menu. Use this to share a direct MCP reference to a specific page with your AI tool.