Remote Terminal MCP for Cursor

Una herramienta de terminal remota para Cursor que permite gestionar y conectarse a servidores remotos mediante SSH, hosts de salto y contenedores Docker.

Documentación

Remote Terminal MCP

Un potente servidor de protocolo de control modular (MCP) para gestión de terminal remota, que proporciona a Cursor funciones completas de configuración de servidores remotos, gestión de conexiones y sincronización de código.

🌟 Características principales

  • Configuración inteligente de servidores - Soporta conexión SSH directa, servidores de salto Relay y contenedores Docker
  • Sistema de sincronización de código - Sincroniza automáticamente repositorios de código locales y remotos
  • Despliegue de servicios FTP - Despliega y gestiona automáticamente servicios FTP remotos
  • Integración con Git - Stash local y sincronización remota
  • Gestión de configuración - Asistente completo de configuración de servidores

🚀 Inicio rápido

Instalación

npm install @xuyehua/remote-terminal-mcp

Configuración

Configura el servidor MCP en Cursor:

{
  "mcpServers": {
    "remote-terminal": {
      "command": "npx",
      "args": ["@xuyehua/remote-terminal-mcp"],
      "env": {}
    }
  }
}

🔄 Guía de uso de herramientas de sincronización

1. Herramienta de sincronización Git (git_sync)

Función: Sincroniza repositorios de código locales y remotos para garantizar la consistencia del código

Casos de uso:

  • Sincronizar el código remoto más reciente antes del desarrollo
  • Garantizar la consistencia entre repositorios locales y remotos
  • Respaldar cambios locales y sincronizar código remoto

Ejemplo de prompt:

# 基本同步
请帮我同步代码库,服务器名称是 "prod-server",本地路径是 "/Users/me/projects/myapp",远程路径是 "/home/user/myapp",使用main分支

# 指定分支同步
请使用git_sync工具同步代码,服务器:dev-server,本地路径:/Users/me/dev/project,远程路径:/home/dev/project,分支:develop

# 强制同步
请强制同步代码库,服务器:test-server,本地路径:/Users/me/test/app,远程路径:/home/test/app,分支:feature/new-ui,强制模式

# 同步到特定提交
请同步代码到特定提交,服务器:prod-server,本地路径:/Users/me/prod/app,远程路径:/home/prod/app,提交哈希:abc123def

Descripción de parámetros:

  • server_name: Nombre del servidor (obligatorio)
  • local_path: Ruta del repositorio Git local (obligatorio)
  • remote_path: Ruta del repositorio Git remoto (obligatorio)
  • branch: Nombre de la rama Git (opcional)
  • commit_hash: Hash de commit específico (opcional)
  • force: Sincronización forzada (opcional, por defecto false)

2. Herramienta de habilitación de sincronización automática (autosync_enable)

Función: Habilita la sincronización automática, despliega servicios FTP remotos y configura la sincronización local

Casos de uso:

  • Sincronizar automáticamente cambios locales al remoto durante el desarrollo
  • Desplegar servicios FTP remotos para sincronización de archivos
  • Configurar la extensión SFTP de VSCode

Ejemplo de prompt:

# 启用自动同步
请启用自动同步功能,服务器:dev-server,本地路径:/Users/me/dev/project,远程路径:/home/dev/project

# 使用默认路径启用
请为prod-server启用自动同步,使用配置中的默认路径

# 自定义FTP配置
请启用自动同步,服务器:test-server,本地路径:/Users/me/test/app,远程路径:/home/test/app,FTP端口:8021,FTP用户:syncuser

# 完整配置启用
请启用自动同步功能,包含以下配置:
- 服务器:prod-server
- 本地路径:/Users/me/prod/app
- 远程路径:/home/prod/app
- FTP端口:8021
- FTP用户:syncuser
- FTP密码:syncpass

Descripción de parámetros:

  • server_name: Nombre del servidor (obligatorio)
  • local_path: Directorio de trabajo local (opcional, por defecto usa la configuración)
  • remote_path: Directorio de trabajo remoto (opcional, por defecto usa la configuración)

3. Herramienta de deshabilitación de sincronización automática (autosync_disable)

Función: Deshabilita la sincronización automática y detiene el servicio FTP remoto

Casos de uso:

  • Detener la sincronización automática después de completar el desarrollo
  • Detener el servicio FTP remoto
  • Limpiar la configuración de sincronización

Ejemplo de prompt:

# 禁用自动同步
请禁用prod-server的自动同步功能

# 停止同步服务
请停止dev-server的自动同步服务

# 清理同步配置
请为test-server禁用自动同步并清理相关配置

Descripción de parámetros:

  • server_name: Nombre del servidor (obligatorio)

📋 Ejemplos de flujo de trabajo completo

Flujo de trabajo de desarrollo

# 1. 开始开发前 - 同步代码
请帮我同步代码库,确保本地和远程一致:
- 服务器:dev-server
- 本地路径:/Users/me/dev/project
- 远程路径:/home/dev/project
- 分支:main

# 2. 启用自动同步 - 开始开发
请启用自动同步功能,这样我修改代码时会自动同步到远程:
- 服务器:dev-server
- 本地路径:/Users/me/dev/project
- 远程路径:/home/dev/project

# 3. 开发完成后 - 停止同步
请禁用dev-server的自动同步功能

Flujo de trabajo de despliegue

# 1. 同步生产代码
请同步生产环境代码:
- 服务器:prod-server
- 本地路径:/Users/me/prod/app
- 远程路径:/home/prod/app
- 分支:release

# 2. 启用生产同步
请为生产环境启用自动同步:
- 服务器:prod-server
- 本地路径:/Users/me/prod/app
- 远程路径:/home/prod/app

# 3. 部署完成后停止
请禁用prod-server的自动同步

🔧 Configuración avanzada

Configuración del servidor

En el asistente de configuración puedes establecer:

  • Información de conexión SSH (host, usuario, puerto)
  • Configuración de contenedores Docker
  • Configuración de sincronización (puerto FTP, usuario, contraseña)
  • Patrones de inclusión/exclusión de archivos

Opciones de configuración de sincronización

  • Puerto FTP: Por defecto 8021
  • Usuario FTP: Por defecto syncuser
  • Patrones de inclusión: *.py, *.js, *.md
  • Patrones de exclusión: *.pyc, pycache, .git

🛠️ Solución de problemas

Problemas comunes

  1. Error de ruta inexistente

    错误:本地路径不存在: /path/to/local
    解决:确保指定的本地路径存在
    
  2. Error de repositorio no Git

    错误:本地路径不是Git仓库: /path/to/local
    解决:确保本地路径包含.git目录
    
  3. Error al iniciar el servicio FTP

    错误:远程FTP服务启动失败
    解决:检查远程服务器权限和网络连接
    

Comandos de depuración

# 检查同步状态
请获取dev-server的同步状态

# 查看服务器配置
请列出所有服务器配置

# 测试连接
请诊断dev-server的连接状态

📚 Más recursos

🤝 Contribuciones

¡Bienvenidos Issues y Pull Requests!

📄 Licencia

Licencia MIT