Skip to content

CLAUDE.md

Latest commit

 

History

History
44 lines (33 loc) · 2.15 KB

CLAUDE.md

File metadata and controls

44 lines (33 loc) · 2.15 KB
Raw

CLAUDE.md

Project

Python client library for x64dbg Automate — RPC-based automation of x64dbg debugger via ZMQ/msgpack.

Commands

poetry install --extras mcp --with dev   # install deps (mcp extra + dev tools)
python -m pytest            # run tests (requires running x64dbg with plugin)
python -m mkdocs serve      # docs dev server

Test env vars

  • TEST_BITNESS — 32 or 64 (default: 64)
  • X64DBG_PATH — path to x64dbg executable

MCP Server

An MCP (Model Context Protocol) server is included, exposing x64dbg automation as MCP tools for LLM-based agents (e.g. Claude Code).

  • Module: x64dbg_automate.mcp_server (mcp_server.py)
  • Entry point: x64dbg-automate-mcp (console script)
  • Install: pip install x64dbg_automate[mcp] (adds the mcp extra dependency)
  • Run: x64dbg-automate-mcp (stdio transport by default)
  • Pattern: Global _client managed via start_session/connect_to_session/disconnect/terminate_session tools; all other tools call _require_client().

Architecture

Mixin chain: XAutoClientBase → XAutoCommandsMixin (low-level RPC) → XAutoHighLevelCommandAbstractionMixin (convenience methods) → X64DbgClient (also mixes in DebugEventQueueMixin).

ZMQ REQ/REP for sync commands, PUB/SUB for async events. Msgpack serialization. Thread-safe via _req_lock.

Git

Keep all commits authored solely as the repo owner (Darius Houle) — do not add Co-Authored-By or other attribution trailers.

Do not add Claude/AI attribution to any GitHub text on this project — commit messages, PR titles and descriptions, PR/issue comments, and issue bodies. This includes the 🤖 Generated with Claude Code footer and any Co-Authored-By: Claude line. All such text must read as authored solely by the repo owner.

Conventions

  • Type hints everywhere, modern union syntax (X | None not Optional[X])
  • Pydantic models for data structures (models.py)
  • Google-style docstrings (Args/Returns/Raises)
  • snake_case functions, PascalCase classes, UPPER_CASE constants
  • Private methods prefixed with _
  • Enums use StrEnum/IntEnum
  • No unnecessary abstractions — keep it direct