IBM Aspera CLI
OfficialServer Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This is the Aspera CLI (ascli) MCP server (IBM Aspera file transfer and management). It exposes a single tool, execute_ascli_command, which runs any ascli command in-process. Its description gives the syntax and the discovery sequence: follow it before any command whose syntax you have not verified in this session.
COMMAND DISPLAY (MANDATORY)
Whenever you execute an ascli command or present its results, you MUST ALWAYS explicitly
show the equivalent command line in your response to the user as bash syntax
(e.g. ascli plugin command --option=value).
Plugins: aoc (Aspera on Cloud), faspex5 (Faspex 5), node (Node API), server (FASP/SSH server), config (local configuration), console, orchestrator, ats, preview, shares, cos, httpgw, faspio, alee.
CREDENTIALS Use saved presets by default: call ["config", "preset", "overview"] first, then pass --preset=, or nothing if a default preset exists for the plugin. If the user provides credentials inline (--url, --username, --password, --private-key), use those exact values verbatim — never substitute a preset or another server. Some plugins support browser login (--auth=web). For a secret the user did not give (password, passphrase), pass "@secret:" as value: the user enters it on a web page, you never see it. Prefer it to asking in the conversation. On error, report it as-is and stop.
TRANSFERS Pass verbatim any flag the user requests (--transfer.agent=, --to-folder, …). Agents: direct (default, in-process ascp), desktop (IBM Aspera Desktop Client, graphical), node, transferd, httpgw, connect. Transfers are asynchronous: the command returns a job_id immediately — never retry it. monitor → ["config", "transfer", "status", "<job_id>"] list → ["config", "transfer", "list"] cleanup → ["config", "transfer", "cleanup"]
ORCHESTRATOR WORKFLOW DEVELOPMENT Before writing or modifying an Orchestrator workflow, read the development guide (large: read sections, not the whole document). Start with the sections "quick-start" and "authoring-checklist": ["orchestrator", "workflows", "development", "guide", "section", "authoring-checklist"] then the sections you need (file format, graph, inputs of steps, execution, recipes, known issues): "workflow-file", "graph-xml", "inputs-of-a-step", "execution", "recipes", "known-issues". Command "toc" lists the anchors of the sections of a document, up to a default level, or the level given after it: ["orchestrator", "workflows", "development", "guide", "toc"] For the template attributes (allowed values), inputs and outputs of an action plugin, and the template settings they depend on, read its specification (fields: section "plugin-specifications" of the development guide); the list of plugins is given by ["orchestrator", "plugins", "spec", "toc"]: ["orchestrator", "plugins", "spec", "show", ""] For the functional description and the setup of a plugin (for example the API client of Faspex), read its section of the Plugin Manual (large: read one section only). The anchor of the section is field "manual_anchor" of the specification of the plugin (also in the list of plugins): ["orchestrator", "workflows", "development", "manual", "section", "<manual_anchor>"] Before importing a workflow file, check it (graph, templates, inputs of steps) and fix all errors: ["orchestrator", "workflows", "check_import", ""]
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| logging | {} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| execute_ascli_commandA | Execute any ascli (Aspera CLI) command in-process and return its result. COMMAND DISPLAY (MANDATORY)
Whenever you execute an ascli command or present its results, you MUST ALWAYS explicitly
show the equivalent command line in your response to the user as bash syntax
(e.g. SYNTAX args is a JSON array of strings mirroring the CLI command line. Element 0 : plugin name (aoc, faspex5, node, server, config, …). Elements 1+: sub-commands, positional arguments, and --option=value flags in any order. Structured values use an extended-value prefix on the relevant element: "@json:{...}" — inline JSON object or array (preferred: no shell quoting) "@preset:name" — expand a saved preset "@base64:..." — base64-encoded value "@val:..." — literal string (no further decoding) "@secret:name" — secret entered by the user on a web page, never visible to you: use it for a secret the user did not give, e.g. "--password=@secret:password" Note: @stdin: is disabled; @ruby:, @file:, @uri:, @env: depend on the security level of the server. A secret (from @secret:, @vault:, @preset:) must be the whole value: no other prefix before it, not in @extend:. AUTOMATIC FLAGS The server prepends extra_args to every call (default: --interactive=no --transfer.asynchronous=true). Do NOT repeat them. To override one, include it in args: later values take precedence. Commands never prompt: if credentials are missing, an error is returned; report it and stop. DISCOVERY — never guess command or field names from training data Step 1 — commands of a plugin, with syntax: ["config", "commands", ""] Returns { syntax, description } for every command of that plugin. Notation: mandatory, [] optional, <a|b> enum, <arg...> variadic, arg:Hash typed. A line ending with <command...> and "(see: )" provides the commands of that path: list them with ["config", "commands", "", "", ...] (command words only). Omit to list the commands of all plugins (large). Step 2 — schema of a Hash argument (shown name:Hash), MANDATORY before calling such a command: ["", "", ..., "help"] Put the literal "help" in place of the Hash argument. Returns field names, types, required flags and descriptions. Never infer fields from server error messages. Step 2b — filter parameters of a list command: ["", "", ..., "--query=help"] Step 3 — all --flags of a plugin, with allowed values: ["config", "options", ""] Documentation: ["config", "documentation", "toc"] → { level, title, anchor } per heading ["config", "documentation", "local", ""] → one README section Presets (saved credentials): ["config", "preset", "overview"] RESULT FORMAT Structured data is always in structuredContent (a JSON object; lists are under "items"). For lists, text content is limited to 100000 bytes (whole items only); when truncated, a WARNING line gives the real total. Read structuredContent.items for the full dataset — never report counts or search results from a truncated text block. FILE LIST FOR TRANSFERS For all transfers (upload, download, package send, …), append source paths at the end of args — no --sources flag needed. EXAMPLES ["config", "commands", "aoc"] ["aoc", "admin", "user", "create", "help"] ["config", "options", "aoc"] ["config", "documentation", "local", "leveraging-ai-assistance"] ["aoc", "--preset=myaoc", "packages", "list"] ["aoc", "--preset=myaoc", "admin", "user", "create", '@json:{"email":"a@b.com","name":"Alice"}'] ["aoc", "--preset=myaoc", "packages", "send", '@json:{"name":"pkg","recipients":["user@example.com"]}', "/local/a.txt", "/local/b.txt"] ["server", "--preset=myserver", "upload", "--to-folder=/uploads", "/local/a.txt"] ["server", "browse", "/", "--url=ssh://host:33001", "--username=user", "--password=secret"] |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 1 tool
There is only one tool, so there is no possibility of selecting the wrong one. Its single purpose — run an ascli argv array — is clearly stated and matches its name.
A single tool named execute_ascli_command uses a clean verb_noun convention and is self-describing. With one tool there is no convention mixing to penalize.
A single generic passthrough tool is a defensible design for a large CLI, but it is coarse: agents get no first-class operations and must chain discovery calls before anything. The surface is thin at the tool layer even though the underlying command space is large.
Because it delegates to the full ascli with built-in introspection of commands, options, argument schemas, and docs, virtually every CLI capability is reachable. The gap is ergonomic rather than functional: common workflows (upload, browse, package send) require multi-step discovery instead of dedicated tools.