Lewati ke isi

Mulai cepat

Panduan ini memakai Docker Compose sebagai runtime pertama dan ChatGPT sebagai client pertama. Keduanya adalah pilihan terpisah: Docker, VS Code extension, binary, Python, dan stdio adalah opsi runtime; ChatGPT dan client MCP generik adalah opsi client. Lihat pilihan runtime dan model deployment untuk gambaran lengkap.

Persyaratan

  • Docker Engine dengan Compose v2.
  • Endpoint HTTPS publik jika ChatGPT harus terhubung dari Web.
  • Direktori workspace khusus.
  • OAuth admin PIN dan JWT secret acak yang panjang.

Warning

Model yang terhubung dapat mengoperasikan workspace yang dikonfigurasi. Jalankan layanan dalam container atau VM yang dapat dibuang dan hindari mount resource pengendali host.

1. Clone dan konfigurasi

git clone https://github.com/fwerkor/local-shell-mcp.git
cd local-shell-mcp
cp .env.example .env

Edit .env:

LOCAL_SHELL_MCP_PUBLIC_BASE_URL=https://your-public-host.example.com
LOCAL_SHELL_MCP_AUTH_MODE=oauth
LOCAL_SHELL_MCP_OAUTH_ADMIN_PIN=change-me-long-random-pin
LOCAL_SHELL_MCP_OAUTH_JWT_SECRET=change-me-64-hex-random-secret
CLOUDFLARE_TUNNEL_TOKEN=

2. Mulai server

mkdir -p workspaces/default
docker compose up -d

Periksa status:

docker compose ps
docker compose logs --tail=100 local-shell-mcp
curl -i http://127.0.0.1:8765/healthz

Respons yang sehat mengembalikan HTTP 200.

3. Publikasikan HTTPS

Untuk sidecar Cloudflare Tunnel:

docker compose --profile tunnel up -d

Di Cloudflare Zero Trust, arahkan public hostname ke:

http://local-shell-mcp:8765

Untuk Caddy, Nginx, Traefik, Nginx Proxy Manager, atau reverse proxy lain, teruskan traffic HTTPS ke 127.0.0.1:8765 atau alamat jaringan container.

4. Hubungkan ChatGPT

Gunakan endpoint MCP:

https://your-public-host.example.com/mcp

Ikuti panduan konektor ChatGPT untuk menyelesaikan OAuth dan persetujuan tools.

5. Konfirmasi akses tools dengan aman

Minta model:

Gunakan local-shell-mcp. Pertama panggil environment_get, lalu daftar root workspace. Jangan ubah file dulu.

Tools read-only yang diharapkan:

  • environment_get
  • file_list
  • file_tree
  • file_read

6. Mulai dengan task coding yang dibatasi

Task pertama yang baik:

Periksa repository ini, rangkum layout project, jalankan test suite yang ada jika jelas, dan jangan mengubah file.

Setelah konektivitas dikonfirmasi, berikan instruksi yang lebih spesifik:

Perbaiki test yang gagal. Baca file terkait terlebih dahulu, buat patch sekecil mungkin, jalankan test target, lalu tampilkan git diff. Jangan commit sampai saya menyetujui.

Pembaruan

docker compose pull
docker compose up -d
curl -i http://127.0.0.1:8765/healthz

Jika menggunakan profil tunnel:

docker compose --profile tunnel pull
docker compose --profile tunnel up -d
curl -i http://127.0.0.1:8765/healthz

Halaman berikutnya

Kebutuhan Halaman
Memahami pilihan runtime dan client Pilihan runtime dan model deployment
Jalankan dengan Docker Compose Docker Compose runtime
Jalankan dari VS Code VS Code extension runtime
Jalankan dengan binary release Runtime binary mandiri
Jalankan dengan Python atau source checkout Python runtimes
Tambahkan ChatGPT sebagai client ChatGPT connector
Pilih tools dan tulis prompt lebih baik Pola penggunaan
Hubungkan mesin HPC, NPU/GPU, atau NAT Worker jarak jauh
Pahami semua tools MCP Referensi tools