ida-code 0.2.1__tar.gz → 0.2.3__tar.gz

{ida_code-0.2.1 → ida_code-0.2.3}/CHANGELOG.md

@@ -4,7 +4,42 @@ All notable changes to this project will be documented in this file.
 
 Format based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## [Unreleased]
+## [0.2.3] - 2026-05-10
+
+### Added
+
+- **Dedicated ida-thread** — new `src/ida_code/ida_thread.py`: a single daemon worker thread that owns idalib. Submit work via `submit()` (sync) or `await on_ida_thread()` (async). idalib hangs when called from any thread other than the one that imported `idapro`; pinning all idalib calls to one thread we control unblocks fastmcp v3 compatibility.
+- **`get_source` tool** — companion to `search_code`. When a search result is truncated (`snippet_start_line` + `total_lines` set), the LLM fetches more lines via `get_source(file, start_line, line_count)`. Sandboxed to the indexed corpora (`python/`, `python/examples/`, `idalib/python/`, `idalib/examples/`); paths outside those roots can't be read.
+
+### Changed
+
+- **fastmcp pin lifted to `>=2.0,<4`** — the ida-thread refactor lets v3 work as well as v2. Verified end-to-end on v3.2.4 with both stdio and in-process transports: `open_database` + `list_functions` + `close_database` complete in <1s on a warm `.i64` cache.
+- **All idalib-touching tools are now `async def`** — every `@mcp.tool` that touches idalib (28 tools) dispatches its body via `await on_ida_thread(_impl, ...)`. The 3 non-idalib tools (`list_architectures`, `search_docs`, `search_code`) stay plain sync `def`. Keeps the asyncio event loop free during idalib work and is transport-agnostic across fastmcp v2 / v3.
+- **`session.py` lazy idapro import** — `import idapro` moved off module top into `_ensure_idalib_loaded()` which runs on the ida-thread on first use. A targeted `signal.signal` monkey-patch silences the `SIGINT, SIG_DFL` install in `idapro/__init__.py:179` that raises `ValueError` on non-main threads (other signal calls pass through). `session.idapro` is the module-level handle, replacing the prior import.
+- **Guidelines refresh** — each `guidelines://` resource now carries (a) Hex-Rays' own IDAPython conventions extracted from `python/examples/README.md` (avoid `idc.py` / `idaapi` / `from X import Y` re-exports; double-quote strings; example docstring header), (b) a "Discovering APIs and examples" footer pointing at `search_docs` / `search_code` / `get_source` so callers know the chain. The standalone-script guideline additionally references the `py-activate-idalib.py` setup path from `idalib/README.txt` for users who'd rather `pip install` than bootstrap manually.
+
+### Changed (BREAKING)
+
+- **`search_examples` → `search_code`** — unified Python-source search that indexes library APIs (formerly under `search_docs`) plus example scripts. New corpora included in the index: the `idapro` Python package (`idalib/python/idapro/*.py`) so signatures like `open_database(file_path, run_auto)` surface from the actual Python wrapper, and `idalib/examples/` so the canonical standalone-idalib example (`idacli.py`) is findable. Adds `kind` filter (`""|"library"|"example"`), `imports` filter (e.g. `imports="idapro"` finds standalone-idalib scripts), `docstring_only: bool` flag to restrict scoring to docstring text for semantic queries, and `include_docs: bool = True` for a `related_docs` cross-link to HTML docs. Library entries weight docstrings at 3x (between name 5x and body 1x) so docstring matches outrank coincidental code-comment matches. Snippet shaping: `max_snippet_lines` caps height, `max_snippet_line_chars` (default 200) truncates each line with `...`, and when a snippet doesn't cover the full source the result includes `snippet_start_line` (1-based, file-absolute) plus `total_lines` so a follow-up read can fetch the rest at the right offset. Result objects are tuned for token efficiency: `score` and `apis` are never emitted, empty fields (level/category/summary/imports) are dropped, `title` is dropped when it equals the filename, and `kind` is dropped when the caller filtered to one. `search_docs` is now HTML-only; its `include_examples` cross-link goes through `search_code(kind="example")` internally.
+
+### Removed
+
+- **`execute` / `execute_file` `timeout` parameter** — the prior implementation used `signal.SIGALRM`, which only delivers to the process main thread. With user code now running on the ida-thread there's no portable way to interrupt it mid-call, so the parameter was removed rather than left as a silently-ignored knob.
+
+## [0.2.2] - 2026-05-07
+
+### Added
+
+- **End-to-end regression test** — `tests/test_e2e.py` opens a real binary through fastmcp's in-process `Client` + `FastMCPTransport`, asserting the call returns within 15s. Catches future regressions that route idalib off the main thread (which would hang). Auto-skips when idalib isn't available.
+
+### Changed
+
+- **Pin fastmcp back to `>=2.0,<3`** — v3 dispatches sync tool functions to `anyio.to_thread.run_sync`, but idalib hangs indefinitely when called from a non-main thread, so every idalib-touching tool wedged. v2 runs sync tools on the main thread and works in 0.7s on the same call. Reverts the v2→v3 bump from 0.2.1.
+- **`open_database` refuses paths with unpacked fragments present** — if `.id0`/`.id1`/`.id2`/`.nam`/`.til` files exist for the target and `overwrite=False`, raise a clear `ToolError` listing them instead of letting idalib return an opaque `-1`. The message warns that the fragments may belong to another active IDA instance and only suggests `overwrite=True` if nothing else owns them.
+
+### Fixed
+
+- **`open_database` overwrite cleans up unpacked fragments** — `overwrite=True` now also deletes `.id0`, `.id1`, `.id2`, `.nam`, and `.til` files, not just `.i64`/`.idb`. A failed open could leave these partial fragments behind, after which every subsequent attempt would fail immediately with a generic `-1` because IDA refused to overwrite the half-written unpacked database.
 
 ## [0.2.1] - 2026-05-05
 

{ida_code-0.2.1 → ida_code-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ida-code
-Version: 0.2.1
+Version: 0.2.3
 Summary: MCP server for AI-assisted IDAPython scripting via idalib
 Project-URL: Homepage, https://github.com/Dil4rd/ida-code
 Project-URL: Repository, https://github.com/Dil4rd/ida-code
@@ -21,7 +21,7 @@ Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Disassemblers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.12
-Requires-Dist: fastmcp<4,>=3.0
+Requires-Dist: fastmcp<4,>=2.0
 Requires-Dist: lief>=0.15
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == 'dev'
@@ -76,7 +76,7 @@ For other MCP clients, run the server directly:
 IDA_INSTALL_DIR=/opt/ida-pro-9.3 ida-code   # stdio transport
 ```
 
-## Tools (35)
+## Tools (36)
 
 Full parameter docs live in each tool's docstring — surfaced automatically to MCP clients via `tools/list`.
 
@@ -90,7 +90,7 @@ Full parameter docs live in each tool's docstring — surfaced automatically to
 | Snapshots | `list_snapshots`, `create_snapshot`, `restore_snapshot`, `delete_snapshot` |
 | Undo/redo | `get_undo_status`, `perform_undo`, `perform_redo` |
 | Inventory | `get_strings`, `get_imports`, `get_exports` |
-| Search | `search_docs`, `search_examples` |
+| Search | `search_docs`, `search_code`, `get_source` |
 
 ## Resources & prompts
 
@@ -156,6 +156,10 @@ uv sync --extra dev
 uv run pytest
 ```
 
+## Known issues
+
+See [KNOWN_ISSUES.md](KNOWN_ISSUES.md) for caveats and workarounds (e.g. why we pin `fastmcp<3`).
+
 The test suite covers the executor, doc/example search, comments, snapshots, structures, undo, variables, and Mach-O parsing. Tests that need idalib are skipped if it's not available.
 
 ## Credits

{ida_code-0.2.1 → ida_code-0.2.3}/README.md

@@ -47,7 +47,7 @@ For other MCP clients, run the server directly:
 IDA_INSTALL_DIR=/opt/ida-pro-9.3 ida-code   # stdio transport
 ```
 
-## Tools (35)
+## Tools (36)
 
 Full parameter docs live in each tool's docstring — surfaced automatically to MCP clients via `tools/list`.
 
@@ -61,7 +61,7 @@ Full parameter docs live in each tool's docstring — surfaced automatically to
 | Snapshots | `list_snapshots`, `create_snapshot`, `restore_snapshot`, `delete_snapshot` |
 | Undo/redo | `get_undo_status`, `perform_undo`, `perform_redo` |
 | Inventory | `get_strings`, `get_imports`, `get_exports` |
-| Search | `search_docs`, `search_examples` |
+| Search | `search_docs`, `search_code`, `get_source` |
 
 ## Resources & prompts
 
@@ -127,6 +127,10 @@ uv sync --extra dev
 uv run pytest
 ```
 
+## Known issues
+
+See [KNOWN_ISSUES.md](KNOWN_ISSUES.md) for caveats and workarounds (e.g. why we pin `fastmcp<3`).
+
 The test suite covers the executor, doc/example search, comments, snapshots, structures, undo, variables, and Mach-O parsing. Tests that need idalib are skipped if it's not available.
 
 ## Credits

{ida_code-0.2.1 → ida_code-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ida-code"
-version = "0.2.1"
+version = "0.2.3"
 description = "MCP server for AI-assisted IDAPython scripting via idalib"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -20,7 +20,7 @@ classifiers = [
     "Topic :: Software Development :: Disassemblers",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["fastmcp>=3.0,<4", "lief>=0.15"]
+dependencies = ["fastmcp>=2.0,<4", "lief>=0.15"]
 
 [project.urls]
 Homepage = "https://github.com/Dil4rd/ida-code"