isabelle-mcp 0.1.0__tar.gz

isabelle_mcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Qiyuan Xu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

isabelle_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: isabelle-mcp
+Version: 0.1.0
+Summary: MCP server bridging AI agents with the Isabelle proof assistant via its LSP/PIDE interface
+Author-email: Qiyuan Xu <xqyww123@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/xqyww123/Isabelle-MCP
+Project-URL: Documentation, https://github.com/xqyww123/Isabelle-MCP/tree/main/docs
+Project-URL: Repository, https://github.com/xqyww123/Isabelle-MCP
+Project-URL: Issues, https://github.com/xqyww123/Isabelle-MCP/issues
+Project-URL: Changelog, https://github.com/xqyww123/Isabelle-MCP/blob/main/CHANGELOG.md
+Keywords: isabelle,theorem-prover,mcp,lsp,ai-assistance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: fastmcp<4,>=3.2
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: my-better-isabelle-prover>=0.1.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: watchdog>=3.0.0
+Provides-Extra: dev
+Requires-Dist: coverage>=7.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Isabelle-MCP
+
+MCP server that lets AI agents (Claude Code, Codex, …) drive the Isabelle
+theorem prover through its LSP/PIDE commands — fully autonomously, with no
+human in the loop.
+
+**Python ≥ 3.12 | v0.1.0 (MVP)**
+
+## Purpose
+
+This MCP server exists so that Claude / Codex can issue Isabelle LSP commands
+**without any human mediation**. The entire Isabelle process is encapsulated
+behind the MCP tools — it exposes **no UI to the user**. The agent works by
+editing `.thy`/`.ML` files on disk and calling the tools to evaluate them and
+query proof states; nobody watches or steers the prover interactively.
+
+This server is **not designed for human–AI collaboration** (there is no
+jEdit/VSCode front-end in the picture). It implements a single
+AI ↔ Isabelle, no-human-in-the-loop model.
+
+> ⚠️ **One agent per server instance.** This server holds a single Isabelle
+> session with global mutable state — one set of open documents, one
+> caret/perspective, and one evaluation in flight at a time. It is
+> **single-threaded and not concurrency-safe**: pointing multiple agents at one
+> instance, or interleaving concurrent requests, corrupts the evaluation/caret/
+> document state with catastrophic, hard-to-debug results. The server runs over
+> **stdio**, so each agent already gets its own dedicated server process (and its
+> own `isabelle vscode_server`) — just don't share one or drive it concurrently.
+
+> [!IMPORTANT]
+> **Patch Isabelle first — this server does not work on a stock Isabelle.** It
+> drives `isabelle vscode_server` through PIDE LSP requests
+> (`PIDE/output_at_position`, `PIDE/cancel_execution`, …) that only exist after
+> applying the
+> [my-better-isabelle-prover](https://github.com/xqyww123/my_better_isabelle_prover)
+> patches:
+>
+> ```bash
+> pip install my-better-isabelle-prover   # via pip or uv tool; needs Python ≥ 3.12
+> my-better-isabelle patch                # apply patches + rebuild the Scala components
+> my-better-isabelle status               # verify: every patch reports "applied"
+> ```
+>
+> `isabelle-mcp install` checks this (when `isabelle` is reachable) and refuses to
+> register the server against an unpatched Isabelle. The server re-checks at
+> run time too: every `isabelle_launch` verifies the patches (via its bundled
+> copy of the patch manager) and refuses to start an unpatched Isabelle —
+> bypass with `isabelle-mcp --skip-patch-check` for hand-patched setups the
+> patch manager cannot recognize. Compatibility notes
+> (PEP 668, non-global Isabelle, …) are in [AGENTS.md](AGENTS.md).
+
+## Quick Start
+
+```bash
+pip install isabelle-mcp      # or: uv tool install isabelle-mcp
+
+# register into Claude Code / Codex (auto-detects whichever is installed):
+isabelle-mcp install
+```
+
+For Claude Desktop, register manually instead
+(`~/.config/claude/claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "isabelle": {
+      "command": "isabelle-mcp"
+    }
+  }
+}
+```
+
+The session/logic is **not** configured here — the agent picks it at run time by
+calling the `isabelle_launch` tool (see Tools below).
+
+## Running the server
+
+```bash
+isabelle-mcp                                  # stdio transport (the only transport)
+isabelle-mcp -- -o editor_output_state=true   # args after `--` go to isabelle vscode_server
+```
+
+The server starts no prover at launch; the connected agent calls `isabelle_launch`
+to start one for a chosen session.
+
+| Flag | Default | Meaning |
+|------|---------|---------|
+| `install` | — | Register the server with Claude Code / Codex (see `isabelle-mcp install --help`) |
+| `--version` | — | Print the version and exit |
+| `--skip-patch-check` | — | Skip the my-better-isabelle-prover patch verification at session launch |
+| `-- ...` | — | Everything after `--` is forwarded to `isabelle vscode_server` |
+
+### Environment variables
+
+These are read once at process startup; a connected agent cannot change them.
+
+| Variable | Default | Effect |
+|----------|---------|--------|
+| `ISABELLE_MCP_EVAL_POLL_INTERVAL` | `10` | Seconds an evaluate/poll call waits before returning `in_progress` |
+| `ISABELLE_MCP_DUMP` | unset | If set to a path, append a JSON wire-log of all LSP traffic (debugging) |
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `isabelle_launch` | Start (or restart) the prover with the session/logic that fits the work (bare `Main` is only a minimal fallback); **call this first** |
+| `isabelle_terminate` | Terminate the running prover (the MCP server stays up; you can relaunch) |
+| `isabelle_evaluate_to` | Evaluate the theory up to a line; returns a per-file snapshot of errors / warnings / running command lines |
+| `isabelle_evaluation_status` | Poll progress of a running evaluation (same snapshot) |
+| `isabelle_cancel_evaluation` | Cancel a running evaluation |
+| `isabelle_hover` | Type info and documentation at position |
+| `isabelle_definition` | Jump to symbol definition |
+| `isabelle_local_occurrences` | In-file occurrences (definition + uses) of a local entity |
+| `isabelle_goal` | **Proof goals** — omit after_text for before/after diff |
+| `isabelle_command_output` | Prover output messages |
+| `isabelle_session_info` | Current session info |
+
+All positions are **1-indexed**. File paths must be **absolute**.
+
+PIDE tools (goal, command_output) are best-effort wrappers around async PIDE notifications and may time out.
+
+## Development
+
+```bash
+pip install -e ".[dev]"             # editable install from a checkout
+pytest                              # unit tests
+pytest -m integration               # requires running Isabelle
+python -m mypy src/                 # type checking
+```
+
+## Architecture
+
+```
+server.py         FastMCP entry point — tool registration, lifespan
+lsp_client.py     JSON-RPC 2.0 client for isabelle vscode_server
+tools/            Tool implementations (one file per tool)
+utils/            Position conversion, URI handling, HTML parsing
+models.py         Pydantic output models
+```
+
+## License
+
+See LICENSE.

isabelle_mcp-0.1.0/README.md

@@ -0,0 +1,144 @@
+# Isabelle-MCP
+
+MCP server that lets AI agents (Claude Code, Codex, …) drive the Isabelle
+theorem prover through its LSP/PIDE commands — fully autonomously, with no
+human in the loop.
+
+**Python ≥ 3.12 | v0.1.0 (MVP)**
+
+## Purpose
+
+This MCP server exists so that Claude / Codex can issue Isabelle LSP commands
+**without any human mediation**. The entire Isabelle process is encapsulated
+behind the MCP tools — it exposes **no UI to the user**. The agent works by
+editing `.thy`/`.ML` files on disk and calling the tools to evaluate them and
+query proof states; nobody watches or steers the prover interactively.
+
+This server is **not designed for human–AI collaboration** (there is no
+jEdit/VSCode front-end in the picture). It implements a single
+AI ↔ Isabelle, no-human-in-the-loop model.
+
+> ⚠️ **One agent per server instance.** This server holds a single Isabelle
+> session with global mutable state — one set of open documents, one
+> caret/perspective, and one evaluation in flight at a time. It is
+> **single-threaded and not concurrency-safe**: pointing multiple agents at one
+> instance, or interleaving concurrent requests, corrupts the evaluation/caret/
+> document state with catastrophic, hard-to-debug results. The server runs over
+> **stdio**, so each agent already gets its own dedicated server process (and its
+> own `isabelle vscode_server`) — just don't share one or drive it concurrently.
+
+> [!IMPORTANT]
+> **Patch Isabelle first — this server does not work on a stock Isabelle.** It
+> drives `isabelle vscode_server` through PIDE LSP requests
+> (`PIDE/output_at_position`, `PIDE/cancel_execution`, …) that only exist after
+> applying the
+> [my-better-isabelle-prover](https://github.com/xqyww123/my_better_isabelle_prover)
+> patches:
+>
+> ```bash
+> pip install my-better-isabelle-prover   # via pip or uv tool; needs Python ≥ 3.12
+> my-better-isabelle patch                # apply patches + rebuild the Scala components
+> my-better-isabelle status               # verify: every patch reports "applied"
+> ```
+>
+> `isabelle-mcp install` checks this (when `isabelle` is reachable) and refuses to
+> register the server against an unpatched Isabelle. The server re-checks at
+> run time too: every `isabelle_launch` verifies the patches (via its bundled
+> copy of the patch manager) and refuses to start an unpatched Isabelle —
+> bypass with `isabelle-mcp --skip-patch-check` for hand-patched setups the
+> patch manager cannot recognize. Compatibility notes
+> (PEP 668, non-global Isabelle, …) are in [AGENTS.md](AGENTS.md).
+
+## Quick Start
+
+```bash
+pip install isabelle-mcp      # or: uv tool install isabelle-mcp
+
+# register into Claude Code / Codex (auto-detects whichever is installed):
+isabelle-mcp install
+```
+
+For Claude Desktop, register manually instead
+(`~/.config/claude/claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "isabelle": {
+      "command": "isabelle-mcp"
+    }
+  }
+}
+```
+
+The session/logic is **not** configured here — the agent picks it at run time by
+calling the `isabelle_launch` tool (see Tools below).
+
+## Running the server
+
+```bash
+isabelle-mcp                                  # stdio transport (the only transport)
+isabelle-mcp -- -o editor_output_state=true   # args after `--` go to isabelle vscode_server
+```
+
+The server starts no prover at launch; the connected agent calls `isabelle_launch`
+to start one for a chosen session.
+
+| Flag | Default | Meaning |
+|------|---------|---------|
+| `install` | — | Register the server with Claude Code / Codex (see `isabelle-mcp install --help`) |
+| `--version` | — | Print the version and exit |
+| `--skip-patch-check` | — | Skip the my-better-isabelle-prover patch verification at session launch |
+| `-- ...` | — | Everything after `--` is forwarded to `isabelle vscode_server` |
+
+### Environment variables
+
+These are read once at process startup; a connected agent cannot change them.
+
+| Variable | Default | Effect |
+|----------|---------|--------|
+| `ISABELLE_MCP_EVAL_POLL_INTERVAL` | `10` | Seconds an evaluate/poll call waits before returning `in_progress` |
+| `ISABELLE_MCP_DUMP` | unset | If set to a path, append a JSON wire-log of all LSP traffic (debugging) |
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `isabelle_launch` | Start (or restart) the prover with the session/logic that fits the work (bare `Main` is only a minimal fallback); **call this first** |
+| `isabelle_terminate` | Terminate the running prover (the MCP server stays up; you can relaunch) |
+| `isabelle_evaluate_to` | Evaluate the theory up to a line; returns a per-file snapshot of errors / warnings / running command lines |
+| `isabelle_evaluation_status` | Poll progress of a running evaluation (same snapshot) |
+| `isabelle_cancel_evaluation` | Cancel a running evaluation |
+| `isabelle_hover` | Type info and documentation at position |
+| `isabelle_definition` | Jump to symbol definition |
+| `isabelle_local_occurrences` | In-file occurrences (definition + uses) of a local entity |
+| `isabelle_goal` | **Proof goals** — omit after_text for before/after diff |
+| `isabelle_command_output` | Prover output messages |
+| `isabelle_session_info` | Current session info |
+
+All positions are **1-indexed**. File paths must be **absolute**.
+
+PIDE tools (goal, command_output) are best-effort wrappers around async PIDE notifications and may time out.
+
+## Development
+
+```bash
+pip install -e ".[dev]"             # editable install from a checkout
+pytest                              # unit tests
+pytest -m integration               # requires running Isabelle
+python -m mypy src/                 # type checking
+```
+
+## Architecture
+
+```
+server.py         FastMCP entry point — tool registration, lifespan
+lsp_client.py     JSON-RPC 2.0 client for isabelle vscode_server
+tools/            Tool implementations (one file per tool)
+utils/            Position conversion, URI handling, HTML parsing
+models.py         Pydantic output models
+```
+
+## License
+
+See LICENSE.

isabelle_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,128 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "isabelle-mcp"
+dynamic = ["version"]
+description = "MCP server bridging AI agents with the Isabelle proof assistant via its LSP/PIDE interface"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Qiyuan Xu", email = "xqyww123@gmail.com"}
+]
+keywords = ["isabelle", "theorem-prover", "mcp", "lsp", "ai-assistance"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "beautifulsoup4>=4.12.0",
+    "fastmcp>=3.2,<4",
+    "mcp>=1.0.0",
+    "my-better-isabelle-prover>=0.1.0",
+    "pydantic>=2.0.0",
+    "watchdog>=3.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage>=7.0.0",
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=7.0.0",
+    "mypy>=1.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/xqyww123/Isabelle-MCP"
+Documentation = "https://github.com/xqyww123/Isabelle-MCP/tree/main/docs"
+Repository = "https://github.com/xqyww123/Isabelle-MCP"
+Issues = "https://github.com/xqyww123/Isabelle-MCP/issues"
+Changelog = "https://github.com/xqyww123/Isabelle-MCP/blob/main/CHANGELOG.md"
+
+[project.scripts]
+isabelle-mcp = "isabelle_mcp.server:main"
+
+[tool.setuptools.dynamic]
+version = {attr = "isabelle_mcp.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+isabelle_mcp = ["py.typed"]
+
+[tool.black]
+line-length = 100
+target-version = ["py312", "py313"]
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.mypy_cache
+  | \.pytest_cache
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = false
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+strict_equality = true
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501",  # line too long (handled by black)
+    "B008",  # do not perform function calls in argument defaults
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+asyncio_mode = "auto"
+markers = [
+    "integration: marks tests as integration tests (deselect with '-m \"not integration\"')",
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+]

isabelle_mcp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

isabelle_mcp-0.1.0/src/isabelle_mcp/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "0.1.0"
+
+from isabelle_mcp.utils.core import IsabelleToolError
+
+__all__ = ["__version__", "IsabelleToolError"]