mcpyghidra 0.6.0__tar.gz

mcpyghidra-0.6.0/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+# NOTE: Scope of this workflow
+# ────────────────────────────
+# Integration and e2e tests require a Ghidra installation
+# (GHIDRA_INSTALL_DIR=/opt/ghidra with Ghidra ≥12.0) and the
+# pyghidra_decaf bootstrap shim, which are not available on
+# GitHub-hosted runners. Those test tiers run in a separate
+# environment with a Ghidra installation available.
+#
+# This workflow therefore runs only the Ghidra-free tiers:
+#   • Lint      — ruff check + ruff format --check (src/)
+#   • Typecheck — mypy (config in root pyproject.toml; targets src/mcpyghidra)
+#   • Unit tests — pytest tests/unit/  (no Ghidra runtime needed)
+#
+# Python matrix: 3.10-3.13 — the full supported range advertised in
+# pyproject.toml.
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Full history needed by hatch-vcs to derive version from tags
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install uv
+        run: pip install --upgrade uv
+
+      - name: Install dependencies
+        run: uv pip install --system -e ".[dev]"
+
+      - name: Lint — ruff check
+        run: ruff check src tests
+
+      - name: Lint — ruff format check
+        run: ruff format --check src
+
+      - name: Type-check (mypy)
+        # mypy config in root pyproject.toml: packages = ["mcpyghidra"], mypy_path = "src"
+        run: mypy
+
+      - name: Unit tests (pytest)
+        # Integration and e2e tests require Ghidra; run unit tier only here.
+        run: pytest tests/unit/ -v --tb=short

mcpyghidra-0.6.0/.github/workflows/release.yml

@@ -0,0 +1,98 @@
+# release.yml — Publish to PyPI on version tag push.
+#
+# PREREQUISITE (one-time setup):
+#   PyPI-side OIDC trusted publisher must be configured before this workflow
+#   can publish.  In your PyPI project settings, add a "pending publisher" with:
+#     Owner:       nightwing-us
+#     Repository:  mcpyghidra
+#     Workflow:    release.yml
+#     Environment: pypi
+#
+#   See: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+#
+# This workflow uses no stored PyPI API token.  Authentication is handled
+# entirely via GitHub's OIDC identity and PyPI's trusted publisher mechanism.
+
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write   # Required for PyPI OIDC trusted publisher authentication
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Full history needed by hatch-vcs to determine version from tags
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install uv
+        run: pip install --upgrade uv
+
+      - name: Build wheel and sdist
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi   # Must match the environment name in PyPI OIDC config
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No token= needed; authentication is via OIDC (id-token: write above)
+
+  github-release:
+    name: Create GitHub Release
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write   # Required to create the release
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        # Use the preinstalled `gh` CLI (GitHub-owned, always allowed by
+        # restrictive org action policies) instead of a third-party action.
+        run: |
+          gh release create "${GITHUB_REF_NAME}" \
+            --repo "${GITHUB_REPOSITORY}" \
+            --title "${GITHUB_REF_NAME}" \
+            --generate-notes \
+            dist/*

mcpyghidra-0.6.0/.gitignore

@@ -0,0 +1,63 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyc
+
+# C extensions
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+
+# Virtual environments
+venv/
+env/
+.env/
+.venv/
+.venv-cov/
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Local development configuration
+.python-version
+
+# joe editor backup files
+*~
+
+# JVM crash reports
+hs_err_pid*.log
+
+src/mcpyghidra/_version.py
+tests/fixtures/*_ghidra/
+
+# coverage JSON exports (not matched by coverage.xml / *.cover above)
+coverage.json
+coverage-combined.json
+coverage_summary.json
+
+# Local MCP server config (developer-local; never published)
+mcpo_config.json

mcpyghidra-0.6.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via GitHub's private vulnerability reporting on this repository (see [SECURITY.md](SECURITY.md) for the link), or by opening a confidential message to a maintainer listed in [CONTRIBUTING.md](CONTRIBUTING.md). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

mcpyghidra-0.6.0/CONTRIBUTING.md

@@ -0,0 +1,177 @@
+# Contributing to mcpyghidra
+
+Thank you for your interest in contributing to `mcpyghidra`.  Contributions
+of all kinds are welcome: bug reports, documentation improvements, and code
+patches.
+
+---
+
+## Code of Conduct
+
+All interactions in this project are governed by our
+[Code of Conduct](CODE_OF_CONDUCT.md).  Please read it before participating.
+
+---
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.10 or later
+- A working [Ghidra](https://ghidra-sre.org/) installation (required at runtime;
+  not needed for lint/typecheck-only work)
+
+### Clone and install
+
+```bash
+git clone https://github.com/nightwing-us/mcpyghidra.git
+cd mcpyghidra
+pip install -e ".[dev]"
+```
+
+### Running the test suite
+
+```bash
+uv run pytest --tb=short
+```
+
+### Linting
+
+```bash
+uv run ruff check src tests
+```
+
+### Type-checking
+
+```bash
+uv run mypy
+```
+
+All three commands must pass before submitting a pull request.  The CI workflow
+runs them automatically on every PR.
+
+---
+
+## DCO Sign-Off Requirement
+
+This project uses the **Developer Certificate of Origin (DCO)** to confirm that
+contributors have the right to submit their contributions under the project
+license.
+
+Every commit in your pull request must carry a `Signed-off-by:` trailer:
+
+```
+Signed-off-by: Jane Doe <jane@example.com>
+```
+
+The name and email must match your real identity.  Add it automatically with
+the `-s` flag:
+
+```bash
+git commit -s -m "fix: correct handling of null MCP response"
+```
+
+By signing off you certify that you agree to the terms at
+<https://developercertificate.org/>.  The full DCO text is reproduced there;
+the core statement is: you wrote the code (or have the right to submit it),
+and you grant the project the right to use it under the Apache-2.0 license.
+
+**DCO enforcement:** A status check on every pull request verifies that all
+commits are signed off.  Pull requests without signed-off commits cannot be
+merged.
+
+---
+
+## Pull Request Process
+
+### Branch naming
+
+Use a short, descriptive branch name prefixed with the change type:
+
+```
+fix/headless-port-assignment
+feat/add-callgraph-tool
+docs/update-installation-guide
+chore/bump-ruff-version
+```
+
+### Commit messages
+
+This repository uses [Conventional Commits](https://www.conventionalcommits.org/).
+Please format commit messages as:
+
+```
+<type>(<optional scope>): <short description>
+
+<optional body>
+
+Signed-off-by: Jane Doe <jane@example.com>
+```
+
+Common types: `fix`, `feat`, `docs`, `chore`, `ci`, `refactor`, `test`.
+
+### Before pushing
+
+Run the full local check suite:
+
+```bash
+uv run ruff check src tests
+uv run mypy
+uv run pytest --tb=short
+```
+
+### Opening the PR
+
+- Target the `main` branch.
+- Fill in the PR description with what changed and why.
+- Link any related issues.
+- Ensure all CI checks pass.
+
+### How your contribution lands
+
+Maintainers review and approve pull requests on GitHub, then integrate
+approved commits via cherry-pick rather than the GitHub "Merge" button.
+As a result your PR will be **closed** (not merged via the button) once
+the change has landed on `main`, and the maintainer will post a comment
+such as:
+
+> Landed in v1.2.3 — commit abc1234.  Thanks!
+
+Your change will appear in the next release.  This is intentional and
+does not mean your contribution was rejected.
+
+---
+
+## Code Style
+
+- **Formatter:** [ruff](https://docs.astral.sh/ruff/) with the configuration in
+  `pyproject.toml` (`[tool.ruff]`).
+- **Type-checking:** [mypy](https://mypy.readthedocs.io/) in gradual mode
+  (not `--strict`).  Annotations are encouraged but not required everywhere:
+  Ghidra-API modules are `Any`-typed via `[[tool.mypy.overrides]]` stubs
+  (the JVM bridge has no static type information), and `warn_return_any` is
+  intentionally disabled to avoid ~80 false-positive ignores on Ghidra wrapper
+  return sites.  Add annotations to new code and tighten existing code
+  incrementally.  If you use `Any` outside of Ghidra-API call sites, add an
+  inline comment explaining why and expect discussion in review.
+- **Import ordering:** ruff handles import ordering as part of formatting
+  (config in `pyproject.toml` `[tool.ruff]`).
+- **Line length:** 120 characters (prose in docstrings: 80 characters).
+- **String quotes:** single quotes preferred (ruff enforces this).
+
+When in doubt, run `ruff check --fix` and `ruff format` to auto-correct most
+style issues before committing.
+
+---
+
+## Reporting Bugs
+
+Open an issue on [GitHub Issues](https://github.com/nightwing-us/mcpyghidra/issues).
+
+For security vulnerabilities, see [SECURITY.md](SECURITY.md).
+
+---
+
+## Questions
+
+Feel free to open a GitHub Discussion or comment on a relevant issue.