Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.convertly.sh/llms.txt

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

Convertly MCP lets AI agents work with approved folders on your computer and call Convertly’s media APIs from the same conversation. Use it to organize downloads, archive old files, convert images, compress media, and look up Convertly documentation before running a workflow. The AI model does not receive unrestricted filesystem access. Your MCP client starts the Convertly MCP server locally, and the server only exposes tools for folders you explicitly approve.

Install

Use npx from any MCP-compatible client:
{
  "mcpServers": {
    "convertly": {
      "command": "npx",
      "args": ["-y", "@convertly/mcp"],
      "env": {
        "CONVERTLY_API_KEY": "ctly_live_...",
        "CONVERTLY_MCP_ROOTS": "/Users/you/Downloads:/Users/you/Pictures"
      }
    }
  }
}
On Windows, separate approved roots with ;:
{
  "mcpServers": {
    "convertly": {
      "command": "npx",
      "args": ["-y", "@convertly/mcp"],
      "env": {
        "CONVERTLY_API_KEY": "ctly_live_...",
        "CONVERTLY_MCP_ROOTS": "C:/Users/you/Downloads;C:/Users/you/Pictures"
      }
    }
  }
}
CONVERTLY_API_KEY is required for conversion and compression tools. Filesystem-only tools, such as scanning and organizing, can run without an API key.

Environment variables

VariableRequiredDescription
CONVERTLY_API_KEYFor API toolsYour Convertly API key.
CONVERTLY_MCP_ROOTSRecommendedApproved folders the MCP server can read or write. If omitted, only the current working directory is approved.
CONVERTLY_BASE_URLNoOverride the Convertly API origin. Defaults to https://convertly.sh.

Tools

Convertly docs

ToolDescription
list_convertly_docsLists available Convertly documentation pages.
search_convertly_docsSearches Convertly docs by topic, API name, or workflow.
get_convertly_docFetches a docs page by slug or URL and returns readable text.

Local files

ToolDescription
list_rootsShows the approved folders.
scan_folderLists files with size, modified date, and media category.
plan_organize_folderCreates a dry-run organization plan by file type.
move_filesMoves approved files after confirm: true.
create_archiveCreates ZIP archives from approved files or folders.
delete_filesDeletes approved files after confirm: true.

Convertly media

ToolDescription
convert_mediaConverts approved local files with the Convertly API.
compress_mediaCompresses approved local image, video, or audio files.
convert_images_to_webpConverts approved local images to WebP.

Example prompts

Search the Convertly docs for compression options, then compress the images in my Downloads folder into an optimized folder. Show me the plan first.
Scan my Downloads folder, group loose files by type, archive media older than 90 days, and convert JPG/PNG images to WebP. Do not delete anything unless I confirm.

Safety model

All file paths are resolved before use and must stay inside CONVERTLY_MCP_ROOTS. Move and delete tools require an explicit confirm: true argument. Organization planning is dry-run by default, so agents can show a plan before modifying files.