AutoDL MCP Server

Permite que Codex gestione los recursos GPU de AutoDL de forma segura y explicable.

Typed MCP tools · Documentation-aware Skill · Confirmation gates · Credential redaction

¿Qué es esto?

AutoDL Plugin es un plugin comunitario para Codex que encapsula la API oficial para desarrolladores de AutoDL junto con la documentación de ayuda completa en dos capas de capacidades:

1. AutoDL MCP Server: 26 herramientas tipadas y validables con parámetros claros, encargadas de consultar el saldo, gestionar instancias de Container Instance Pro, operar Elastic Deployment, consultar el inventario de imágenes/GPU, leer los paquetes de tiempo, enviar notificaciones de WeChat y obtener métricas de contenedores.

2. AutoDL Skill: permite que el agente comprenda la facturación, la retención de datos, el disco del sistema/disco de datos, las imágenes, la red, SSH, CUDA, el entorno de entrenamiento y los límites de permisos de AutoDL, y ejecute el flujo correcto antes de operaciones de alto riesgo.

No es un simple "repetidor de interfaces HTTP". El plugin distingue entre operaciones de solo lectura, de cambio de estado, de facturación y destructivas; antes de crear, encender, apagar, liberar, escalar, eliminar o enviar mensajes de verdad, debe pasar por una puerta de confirmación.

[!IMPORTANT] Esta es una integración comunitaria, no un producto oficial de AutoDL. La capacidad real del servicio, los precios, el inventario, las cuotas y las reglas se rigen por el sitio web oficial de AutoDL y la documentación oficial.

Related MCP server: AutoDL MCP Server

Aspectos destacados

• 26 herramientas MCP tipadas: cada interfaz tiene un nombre independiente, descripción de parámetros y validación de entrada.

• Puertas de confirmación de seguridad: las operaciones de cambio solo devuelven una vista previa de la solicitud cuando confirm=false, sin acceder a AutoDL.

• Protección de credenciales: los detalles de la instancia ocultan root_password y jupyter_token por defecto.

• Aislamiento de tokens: el token de desarrollador solo se lee del entorno local y no entra en el código fuente, la salida de las herramientas ni los fixtures de prueba.

• Conocimiento completo de la documentación: indexa 103/103 páginas del sitio de ayuda oficial y 463 entradas de búsqueda.

• Comprobación de desviación de documentación: puede volver a rastrear el directorio oficial y generar el estado de las páginas y un manifiesto SHA-256.

• Pruebas MCP reales: invoca todas las herramientas mediante el handshake stdio, en lugar de probar solo funciones internas.

• Verificación de solo lectura en entorno real: el saldo, la lista de instancias Pro y la lista de imágenes Pro ya se han verificado con la API real de AutoDL.

Arquitectura

flowchart LR
    U["User / Codex"] --> S["AutoDL Skill"]
    S -->|"选择工具与安全流程"| M["Typed MCP Server"]
    M --> G{"Confirmation gate"}
    G -->|"只读"| A["AutoDL Developer API"]
    G -->|"变更且 confirm=true"| A
    G -->|"confirm=false"| P["Request preview only"]
    A --> R["Redaction + structured result"]
    R --> U
    D["103 official docs pages"] --> S

Inicio rápido

1. Clonar e instalar

git clone https://github.com/wuzihuang/AUTODL-PLUGIN.git
cd AUTODL-PLUGIN
npm install

Requisitos: Node.js 20 o superior.

2. Configurar el token de AutoDL

Obtén el token de desarrollador en la configuración de la cuenta de la consola de AutoDL y crea un archivo de entorno local:

cp .env.example .env

Edita .env:

AUTODL_TOKEN=你的开发者Token

.env está ignorado por Git. No escribas tokens reales en el README, ejemplos de configuración, Issues, registros o commits.

También puedes omitir la creación de .env y proporcionar la variable en el entorno donde se inicia Codex:

export AUTODL_TOKEN='你的开发者Token'

3. Cargar el plugin en Codex

Selecciona el directorio raíz de este repositorio en Codex si admite plugins locales. Codex hará lo siguiente a través de:

• .codex-plugin/plugin.json para descubrir el AutoDL Skill;

• .mcp.json para iniciar el AutoDL MCP Server local.

Si tu cliente aún no admite plugins locales, puedes configurar MCP manualmente:

{
  "mcpServers": {
    "autodl": {
      "command": "bash",
      "args": ["/absolute/path/AUTODL-PLUGIN/scripts/start-mcp.sh"],
      "cwd": "/absolute/path/AUTODL-PLUGIN"
    }
  }
}

El Skill también se puede instalar por separado:

cp -R skills/autodl ~/.codex/skills/autodl

4. Prueba a preguntar así

• "Consulta mi saldo de AutoDL y conviértelo a yuanes."

• "Enumera mis instancias Pro e indica cuáles siguen facturando."

• "Consulta el inventario de Elastic Deployment de RTX 4090 en westDC2."

• "Quiero crear una instancia de una sola GPU; primero dame los parámetros y la vista previa del riesgo de coste, sin crearla directamente."

• "Antes de guardar el entorno de esta instancia, ¿qué datos debo respaldar por separado?"

• "¿Por qué la versión de CUDA de nvidia-smi es diferente de la CUDA del entorno?"

Resumen de herramientas MCP

Cuenta y almacenamiento

Container Instance Pro

Elastic Deployment

Notificaciones y monitorización

Los campos completos, las rutas de las interfaces, los códigos de región, las especificaciones de GPU y los ejemplos de imágenes base se encuentran en API Reference.

Matriz de permisos

Si la API devuelve "sin permiso de acceso al recurso actual", el plugin lo interpretará como un problema de autenticación o de permisos del producto, en lugar de informarlo erróneamente como un fallo de MCP.

Modelo de seguridad

Puertas de confirmación

Todas las herramientas que generan costes, cambian el estado, detienen cargas de trabajo, eliminan datos o envían mensajes externos tienen un parámetro confirm:

confirm=false  → 返回方法、路径、目标与参数预览，不发送网络请求
confirm=true   → 执行真实 AutoDL API 请求

El agente debe seguir explicando al usuario antes de ejecutar:

• El ID exacto de la instancia, el despliegue o el contenedor;

• El número de GPUs, instancias o réplicas;

• El límite de precio y el impacto en la facturación;

• Si se interrumpe el entrenamiento o el servicio;

• Si el disco del sistema y el disco de datos ya se han respaldado.

Datos y credenciales

• root_password y jupyter_token se muestran como [REDACTED] por defecto.

• Las solicitudes de métricas locales no llevan el token de desarrollador de AutoDL.

• El token no aparece en los resultados estructurados de MCP ni en los resultados de error.

• La liberación de instancias y la eliminación de despliegues están marcadas como destructivas.

• El flujo de liberación de instancias Pro requiere apagar primero.

Límites de uso de AutoDL

• Está estrictamente prohibido utilizar los recursos para minería de criptomonedas.

• El disco del sistema local y el disco de datos no tienen garantía de redundancia ni fiabilidad; los datos importantes deben respaldarse.

• Las direcciones de los servicios mapeados deben mantenerse privadas y cumplir el acuerdo de servicios personalizados de AutoDL.

• Los precios, promociones, inventario, regiones, cuotas y fechas de las políticas actuales deben verificarse en tiempo real.

Más reglas en Operations Guide y Security Policy.

Detalles técnicos clave

• Host de la API: https://api.autodl.com

• Autenticación: Authorization: <raw token>, sin Bearer

• Criterio de éxito: code === "Success"

• Importes: los enteros relacionados de la API se dividen entre 1000 para obtener los yuanes

• Codificación de CUDA: por ejemplo, 118 significa CUDA 11.8

• Estado/detalles de Pro: la documentación oficial lo define como GET + JSON body

• Inventario de GPU: según el criterio de programación por GPU individual; no puede demostrar que varias GPUs estén en el mismo host

• NFS dedicado: mountable=1; volver al almacenamiento de archivos normal: mountable=-1

Configuración

Pruebas

Pruebas automáticas completas

npm test

Las pruebas incluyen:

• Validación del manifiesto del plugin de Codex y de la configuración de MCP;

• Frontmatter del Skill, archivos de referencia y cobertura de las 26/26 herramientas;

• Lista de las 103/103 páginas de la documentación oficial;

• Inicialización de MCP por stdio y descubrimiento de herramientas;

• Llamadas mock completas de las 26/26 herramientas;

• Método HTTP, ruta, query y GET JSON body;

• Sin solicitudes de red para cambios no confirmados;

• Mapeo de errores de negocio de AutoDL;

• Sin fugas de tokens;

• Redacción por defecto de las credenciales de la instancia;

• Las solicitudes de métricas locales no llevan token.

Pruebas de solo lectura en entorno real

npm run test:live

Este comando solo lee saldo, instancias, imágenes, despliegues y listas negras, entre otros; no crea ni modifica recursos. Las interfaces empresariales sin permiso se marcan como SKIP/PERMISSION.

Registro de verificación actual:

• Saldo de la cuenta: HTTP 200

• Lista de instancias Pro: HTTP 200

• Lista de imágenes privadas Pro: HTTP 200

• Elastic Deployment: la cuenta de prueba no tiene permiso de acceso; se omite de forma segura

• Estado/detalles de Pro: la cuenta de prueba no tiene instancias existentes; se omite condicionalmente

Consulta el informe de pruebas completo.

Cobertura de la documentación oficial

El script de actualización de documentación lee el índice de búsqueda MkDocs de AutoDL, comprueba el contenido de cada página y genera:

• Índice de documentación por página

• Manifiesto de auditoría de documentación

Instantánea actual:

Actualización:

npm run docs:refresh
npm test

El repositorio no copia la documentación completa de AutoDL; solo guarda el índice de rutas, las reglas de resumen y los metadatos hash. Debes volver a consultar las páginas oficiales para precios, autenticación, inventario, cuotas y políticas.

Estructura del proyecto

AUTODL-PLUGIN/
├── .codex-plugin/plugin.json      # Codex 插件清单
├── .mcp.json                      # MCP 自动发现配置
├── assets/                        # Logo 与 README Banner
├── mcp/
│   ├── src/                       # MCP Server 与 AutoDL HTTP Client
│   └── test/                      # 全工具契约测试、只读实时测试
├── skills/autodl/
│   ├── SKILL.md                   # Agent 工作流与安全规则
│   ├── references/                # API、运维规则、文档索引
│   └── scripts/                   # 文档刷新与 Skill 校验
├── scripts/
│   ├── start-mcp.sh               # 插件 MCP 启动入口
│   └── validate-plugin.mjs        # 插件与敏感信息校验
├── docs/TEST_REPORT.md
└── .github/workflows/ci.yml

Desarrollo y contribuciones

Se agradecen nuevas interfaces públicas, ejemplos de respuestas, descripciones de permisos y correcciones de desviación de documentación. Lee primero CONTRIBUTING.md.

Flujo básico:

npm install
npm test

Al añadir una interfaz de cambio de estado, debes:

1. Usar una herramienta tipada independiente;

2. Añadir la puerta de vista previa confirm;

3. Describir el impacto en la facturación, la interrupción y los datos;

4. Añadir pruebas de contrato mock;

5. No ejecutar pruebas CI destructivas con cuentas reales.

Licencia

MIT

El nombre, los servicios y la documentación oficial de AutoDL pertenecen a sus titulares de derechos. Este proyecto solo ofrece una integración comunitaria y no representa un respaldo oficial de AutoDL.