Opt-in local audit log of executed state-changing tool calls

Đang mở
#159 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
72/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
node.js, typescript
Lĩnh vực
observability, security

Hướng nghiên cứu

Start by reading mcp-server/src/utils/confirm-param.ts — it is the shared gate all twelve confirmed tools pass through, so the append belongs there rather than in each tool. Look at mcp-server/src/tools/nodeExec.ts:22 for the shape of a gated call and at mcp-server/src/index.ts:130 for the existing (only) logging pattern, then run cd mcp-server && npm install && npm test plus npm run typecheck. Done means: with HOMELAB_AUDIT_LOG set, a confirmed gated call appends one JSON line with timestamp, tool, node, host, masked command, exit status and duration, no secret values, covered by a unit test.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement severity: medium

Summary

Twelve tools change remote state behind confirm: true, but nothing records what was executed.

Where

  • mcp-server/src/tools/nodeExec.ts:22
  • mcp-server/src/index.ts:130 (the only logging in src)

Details

After an agent session a user cannot answer "what did the AI run on my Pi, and when", which matters most for nodeExec, backupRestore and composeDown.

Impact

No after-the-fact record of agent actions on the user's hardware.

Suggested fix

Add opt-in HOMELAB_AUDIT_LOG=<path>: every confirmed gated call appends one JSON line (timestamp, tool, node, host, masked command, exit status, duration). Hook it in one place shared by the gated tools. Never log secret values.

Open questions: also log cancelled previews and dry runs? Rotate the file?

Acceptance criteria

  • Gated calls append a JSON line when the variable is set
  • No secret values in the log
  • Unit test

Getting started

  • Relevant files: mcp-server/src/utils/confirm-param.ts, mcp-server/src/tools/nodeExec.ts, mcp-server/src/index.ts
  • How to run tests: cd mcp-server && npm install && npm test (and npm run typecheck); structure tests: pip install -r requirements-test.txt && pytest tests/ -v
  • Conventions: see CLAUDE.md and CONTRIBUTING.md

Filed by repo-audit/full-audit at 636fefb. Severity: medium. Effort: M. audit-key: enhancement|mcp-server/src/utils/confirm-param.ts|audit-log

Ngôn ngữ chính
TypeScript
Star
0
Fork
4
Merge trung bình
10 giờ 16 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/Home-Lab-Developer-Tools

Tất cả issue của TMHSDigital/Home-Lab-Developer-Tools

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.