Documentationv0.2.0 / schema 1.1

Bắt đầu

Cài đặt Signalint trong dự án JavaScript hoặc TypeScript, kết nối MCP client và chạy lần kiểm tra đầu tiên.

Yêu cầu

  • Node.js 20.19 trở lên thuộc nhánh Node 20, hoặc Node.js 22.12 trở lên.
  • Một dự án JavaScript hoặc TypeScript.
  • File tsconfig.json ở gốc dự án khi bật kiểm tra TypeScript.

Cài đặt và khởi tạo

npm install --save-dev signalint-mcp
npx signalint-mcp init

Chạy cả hai lệnh từ dự án mà Signalint sẽ kiểm tra. Lệnh init phát hiện file cấu hình TypeScript ở gốc, cấu hình Oxlint và cấu hình Biome, sau đó ghi filesignalint.config.json tương ứng. Nếu tìm thấy đúng một MCP client ở gần, lệnh sẽ đề nghị ghi cấu hình server; nếu phát hiện chưa rõ ràng, lệnh sẽ hỏi bạn muốn cấu hình client nào hoặc in ra đoạn mã snippet chính xác.

Tiếp tục với Cài đặt & client để xem cấu hình tự động hoàn chỉnh, các lệnh theo từng hệ điều hành, file JSON client và tài liệu tham khảo MCP chính thức cho Claude Code/Cursor.

Kết nối client

Claude Code

Trên Windows native, sử dụng wrapper cmd /c:

claude mcp add --scope project signalint -- cmd /c npx --no-install signalint-mcp
claude mcp get signalint

Trên macOS hoặc Linux, bỏ cmd /c.

Cursor

Tạo file .cursor/mcp.json trong dự án được kiểm tra:

{
  "mcpServers": {
    "signalint": {
      "command": "npx",
      "args": ["--no-install", "signalint-mcp"]
    }
  }
}

Trên Windows native, đặt command thành cmd và đặt args thành ["/c", "npx", "--no-install", "signalint-mcp"].

Antigravity

Lệnh init có thể cập nhật cấu hình MCP của Antigravity, thường nằm tại %USERPROFILE%\.gemini\antigravity\mcp_config.json trên Windows. Sử dụng cùng dạng Windows cmd /c npx và đặt cwd thành gốc dự án tuyệt đối.

Xác minh kết nối

  1. Khởi động lại hoặc kết nối lại MCP client sau khi thay đổi cấu hình.
  2. Gọi ping với đối tượng rỗng. Kết quả trả về phải là pong.
  3. Gọi check_project với { "paths": ["."] }.

Signalint ghi cache cục bộ và dữ liệu phiên vào .signalint/. Giữ thư mục đó bên ngoài version control.

Kiểm tra không cần MCP client

npx --no-install signalint check .

Lệnh sẽ thoát với mã exit 1 khi tìm thấy lỗi chẩn đoán, đây là hành vi kiểm tra tiêu chuẩn.