Remote Terminal MCP for Cursor

Uma ferramenta de terminal remoto para Cursor gerenciar e conectar a servidores remotos via SSH, hosts de salto e contêineres Docker.

Documentação

Remote Terminal MCP

Um poderoso servidor de Protocolo de Controle Modular (MCP) para gerenciamento de terminal remoto, fornecendo configuração completa de servidores remotos, gerenciamento de conexões e sincronização de código para o Cursor.

🌟 Principais Recursos

  • Configuração Inteligente de Servidores - Suporte a conexão SSH direta, servidores de salto Relay e contêineres Docker
  • Sistema de Sincronização de Código - Sincronização automática de repositórios de código locais e remotos
  • Implantação de Serviço FTP - Implantação e gerenciamento automático de serviços FTP remotos
  • Integração com Git - Stash local e sincronização remota
  • Gerenciamento de Configuração - Assistente completo de configuração de servidores

🚀 Início Rápido

Instalação

npm install @xuyehua/remote-terminal-mcp

Configuração

Configure o servidor MCP no Cursor:

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

🔄 Guia de Uso das Ferramentas de Sincronização

1. Ferramenta de Sincronização Git (git_sync)

Função: Sincroniza repositórios de código locais e remotos, garantindo consistência do código

Casos de uso:

  • Sincronizar o código remoto mais recente antes do desenvolvimento
  • Garantir que os repositórios locais e remotos estejam consistentes
  • Fazer backup das alterações locais e sincronizar o código remoto

Exemplo 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

Descrição dos parâmetros:

  • server_name: Nome do servidor (obrigatório)
  • local_path: Caminho do repositório Git local (obrigatório)
  • remote_path: Caminho do repositório Git remoto (obrigatório)
  • branch: Nome do branch Git (opcional)
  • commit_hash: Hash de commit específico (opcional)
  • force: Sincronização forçada (opcional, padrão false)

2. Ferramenta de Ativação de Sincronização Automática (autosync_enable)

Função: Ativa a sincronização automática, implanta o serviço FTP remoto e configura a sincronização local

Casos de uso:

  • Sincronizar automaticamente alterações locais para o remoto durante o desenvolvimento
  • Implantar serviço FTP remoto para sincronização de arquivos
  • Configurar a extensão SFTP do VSCode

Exemplo 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

Descrição dos parâmetros:

  • server_name: Nome do servidor (obrigatório)
  • local_path: Diretório de trabalho local (opcional, usa a configuração por padrão)
  • remote_path: Diretório de trabalho remoto (opcional, usa a configuração por padrão)

3. Ferramenta de Desativação de Sincronização Automática (autosync_disable)

Função: Desativa a sincronização automática e interrompe o serviço FTP remoto

Casos de uso:

  • Parar a sincronização automática após concluir o desenvolvimento
  • Interromper o serviço FTP remoto
  • Limpar a configuração de sincronização

Exemplo de prompt:

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

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

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

Descrição dos parâmetros:

  • server_name: Nome do servidor (obrigatório)

📋 Exemplos de Fluxo de Trabalho Completo

Fluxo de Trabalho de Desenvolvimento

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

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

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

Fluxo de Trabalho de Implantação

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

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

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

🔧 Configuração Avançada

Configuração do Servidor

No assistente de configuração, você pode definir:

  • Informações de conexão SSH (host, usuário, porta)
  • Configuração de contêineres Docker
  • Configuração de sincronização (porta FTP, usuário, senha)
  • Padrões de inclusão/exclusão de arquivos

Opções de Configuração de Sincronização

  • Porta FTP: Padrão 8021
  • Usuário FTP: Padrão syncuser
  • Padrões de inclusão: *.py, *.js, *.md
  • Padrões de exclusão: *.pyc, pycache, .git

🛠️ Solução de Problemas

Problemas Comuns

  1. Erro de caminho inexistente

    错误:本地路径不存在: /path/to/local
    解决:确保指定的本地路径存在
    
  2. Erro de repositório não-Git

    错误:本地路径不是Git仓库: /path/to/local
    解决:确保本地路径包含.git目录
    
  3. Falha ao iniciar o serviço FTP

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

Comandos de Depuração

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

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

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

📚 Mais Recursos

🤝 Contribuição

Contribuições são bem-vindas! Envie Issues e Pull Requests!

📄 Licença

Licença MIT