deepquery-sdk 1.0.0__tar.gz

deepquery_sdk-1.0.0/.gitignore

@@ -0,0 +1,35 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Packaging / build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+venv/
+.venv/
+env/
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+
+# Environment / secrets
+.env
+.env.*
+.pypirc
+
+# OS / editor
+.DS_Store
+Thumbs.db
+.vscode/
+.idea/

deepquery_sdk-1.0.0/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to DeepQuerySDK are documented here. The SDK follows
+[Semantic Versioning](https://semver.org). A breaking change to the base
+`Connector` class, the provenance envelope, or the manifest schema is a **major**
+bump and ships with an entry in [MIGRATIONS.md](MIGRATIONS.md).
+
+## [1.0.0] — 2026-06-07
+
+First stable release. Establishes the SDK contract at **major version 1**:
+connectors declaring `sdk_major_version = 1` are loadable by this runtime.
+
+### Core contracts (Phase 1)
+- Base `Connector`, `@resource`, and `@action` abstractions.
+- Read/action classification, surfaced as `dq.mutates` / `dq.kind` MCP metadata.
+- The provenance envelope and `self.cite(...)` helper.
+- `mcp_emit` layer wrapping the official MCP server SDK — every connector emits a
+  compliant MCP server.
+
+### Safety & auth (Phase 2)
+- Gated action lifecycle: **preview → approve → execute** and **reject**, driven
+  by single-use, argument-bound approval tokens and the `dq.execute_action` /
+  `dq.reject_action` control tools.
+- Auth strategies (`ApiKeyAuth`, `BasicAuth`, `BearerAuth`, `OAuth2Auth`,
+  `MTLSAuth`) and OAuth 2.1 PKCE flow-construction scaffolding.
+- Gateway credential injection via a call-scoped provider; connectors never store
+  credentials.
+
+### Tooling & harness (Phase 3)
+- `deepquery` CLI: `scaffold`, `validate`, `run-dev`, `emit`, `manifest`.
+- `validate` encodes the §5/§6/§13 safety contracts, including AST detection of a
+  resource that mutates (a misclassified action).
+- `MockAgent` dev harness driving reads and the full action/approval flow over a
+  real in-memory MCP session.
+
+### Packaging & versioning (Phase 4)
+- Semver compatibility contract and manifest version negotiation
+  (`assert_compatible`); the gateway refuses connectors built against an
+  incompatible SDK major with a clear error.
+- `scaffold` generates a complete, shippable connector project.
+- Published to PyPI as `deepquery-sdk`.
+
+[1.0.0]: https://github.com/GilbertAshivaka/deepquery-sdk/releases/tag/v1.0.0

deepquery_sdk-1.0.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Deep Query
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

deepquery_sdk-1.0.0/MIGRATIONS.md

@@ -0,0 +1,47 @@
+# Migration Guides
+
+This document describes **how** DeepQuerySDK handles breaking changes, and holds
+a migration guide for every major-version bump.
+
+## The compatibility contract (§11)
+
+- Every connector manifest declares the SDK **major** version it targets
+  (`sdk_major_version`).
+- At load time the Connector Gateway calls `assert_compatible(manifest)`:
+  - same major as the runtime → **loads**.
+  - newer major than the runtime → **refused**: upgrade the deployment's SDK.
+  - older major than the runtime → **refused**: the connector must be migrated to
+    the current major using the guide below.
+- This protects deployments: an admin who approved Connector X v1 can trust that
+  a v1.x auto-upgrade won't change what the connector can do, and that a v2
+  upgrade is flagged as requiring fresh review.
+
+## What forces a major bump
+
+A change is **major** (and requires a migration guide entry) if it breaks any of:
+
+- the base `Connector` class surface (method names/signatures developers override),
+- the `@resource` / `@action` decorator contracts,
+- the provenance envelope fields,
+- the manifest schema,
+- the emitted MCP shape that the gateway depends on (e.g. `dq.*` metadata keys,
+  the control-tool protocol).
+
+Adding a capability or an optional field is **minor**; fixing behavior without
+changing any interface is a **patch**.
+
+## The process for shipping a major version
+
+1. Land the breaking change behind a new `SDK_MAJOR_VERSION`.
+2. Add a `## v(N-1) → vN` section below with concrete before/after steps.
+3. Add a `CHANGELOG.md` entry referencing this guide.
+4. Where feasible, ship a deprecation period: support both shapes for one minor
+   release with a runtime warning before removing the old one.
+
+---
+
+## v1 → v2
+
+_No v2 yet._ When the first breaking change lands, this section will list each
+change with a before/after example and the minimum edits a connector author must
+make to retarget `sdk_major_version = 2`.

deepquery_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: deepquery-sdk
+Version: 1.0.0
+Summary: Connector Development Kit for Deep Query — build MCP-emitting connectors with built-in read/action safety classification and provenance.
+Project-URL: Homepage, https://github.com/GilbertAshivaka/deepquery-sdk
+Project-URL: Repository, https://github.com/GilbertAshivaka/deepquery-sdk
+Project-URL: Changelog, https://github.com/GilbertAshivaka/deepquery-sdk/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/GilbertAshivaka/deepquery-sdk/blob/main/README.md
+Author-email: Gilbert Ashivaka <gilbertashivaka@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: connector,deepquery,mcp,model-context-protocol,rag
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Requires-Dist: mcp<2,>=1.10
+Requires-Dist: pydantic<3,>=2
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.25; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# DeepQuerySDK — Connector Development Kit
+
+Build connectors for Deep Query. A connector you write with this SDK **emits a
+standard [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server**
+— so Deep Query consumes it through the exact same interface as any public MCP
+server. You never touch JSON-RPC, transport, or schema plumbing.
+
+> **Status: v1.0.0 — all four build phases complete.** Core contracts (Phase 1),
+> the gated **preview → approve → execute / reject** lifecycle + OAuth 2.1 PKCE
+> scaffolding + credential injection (Phase 2), the `deepquery` **CLI** and
+> **mock-agent harness** with the §5/§6/§13 contracts encoded as `validate`
+> checks (Phase 3), and the semver **compatibility contract** + packaging
+> (Phase 4). The SDK contract is at **major version 1**: connectors declaring
+> `sdk_major_version = 1` are loadable by this runtime.
+
+## What you define
+
+A connector is a subclass of `Connector` that declares three things:
+
+| You define | What it is | Gated? |
+|---|---|---|
+| **Resources** | read-only data the agent can retrieve and **cite** | no |
+| **Actions** | operations that change external state | yes (preview → execute) |
+| **Auth** | how the connector authenticates to the external system | n/a |
+
+Every read carries a **provenance envelope** so live data can be cited honestly.
+Every action is tagged `dq.mutates: true` in the emitted MCP server so Deep
+Query's approval gate knows it must be confirmed by a human.
+
+## Install (development)
+
+```powershell
+# from the DeepQuerySDK/ folder, using the bundled venv
+venv\Scripts\python.exe -m pip install -e .
+```
+
+## 60-second example
+
+```python
+from deepquery_sdk import Connector, OAuth2Auth, resource, action
+
+class JiraConnector(Connector):
+    name = "jira"
+    version = "0.1.0"
+    description = "Read and act on Jira issues."
+
+    # Declare OAuth 2.1 with least-privilege scopes. The gateway runs/stores the
+    # grant and injects the token; this connector never stores credentials.
+    auth = OAuth2Auth(
+        authorize_endpoint="https://auth.atlassian.com/authorize",
+        token_endpoint="https://auth.atlassian.com/oauth/token",
+        scopes=["read:jira-work", "write:jira-work"],
+    )
+    requires_network = True
+
+    @resource(description="Search Jira issues by text query.",
+              input_schema={"type": "object",
+                            "properties": {"query": {"type": "string"}},
+                            "required": ["query"]})
+    def search_issues(self, query: str):
+        # ... call the real Jira API here ...
+        return [
+            self.cite(
+                {"key": "DQ-431", "summary": "Login flow broken", "status": "In Review"},
+                source_object_id="DQ-431",
+                title_or_label="DQ-431 — Login flow broken",
+                deep_link="https://example.atlassian.net/browse/DQ-431",
+                mutability_note="live status field",
+            )
+        ]
+
+    @action(description="Create a new Jira issue.",
+            input_schema={"type": "object",
+                          "properties": {"project": {"type": "string"},
+                                         "summary": {"type": "string"}},
+                          "required": ["project", "summary"]})
+    def create_issue(self, project: str, summary: str):
+        # only ever called after the approval gate confirms the preview.
+        auth = self.apply_auth()  # headers built from the injected credential
+        return {"created": f"{project}-NEW", "summary": summary}
+
+    @create_issue.preview
+    def _(self, project: str, summary: str) -> str:
+        return f"Will create a new issue in project '{project}' titled '{summary}'."
+```
+
+Emit and serve it as an MCP server (the gateway injects the credential):
+
+```python
+from deepquery_sdk import Credential, static_credential_provider
+from deepquery_sdk.mcp_emit import run_stdio
+
+connector = JiraConnector()
+connector.set_credential_provider(static_credential_provider(Credential(token="...")))
+run_stdio(connector)
+```
+
+## The gated action lifecycle
+
+Calling an action does **not** execute it. It returns a preview and a single-use
+approval token; the gateway drives the decision through two control tools:
+
+```
+call create_issue(args)        -> { status: "preview", approval_token, preview, arguments }
+call dq.execute_action(token)  -> runs execute() for exactly those args  (after human approval)
+call dq.reject_action(token)   -> discards the action; it never runs
+```
+
+The token binds the previewed arguments, so execute can never drift from what the
+human approved, and a rejected/used token can never run.
+
+## The `deepquery` CLI
+
+```bash
+deepquery scaffold acme-crm           # generate a new connector from the template
+deepquery validate connector.py       # enforce the §5/§6/§13 safety contracts
+deepquery manifest connector.py       # print/export the connector manifest
+deepquery run-dev connector.py        # drive it interactively with the mock agent
+deepquery emit connector.py --out dist/   # produce the deployable MCP server artifact
+```
+
+A target can be a `path/to/connector.py`, a directory containing `connector.py`,
+or a `module.path:ClassName`. `validate` is the gatekeeper: it statically scans
+`@resource` bodies for mutating calls and **fails a resource that writes** (a
+misclassified action), plus checks descriptions, manifest, deployment honesty,
+and least-privilege scopes.
+
+The dev harness (`deepquery_sdk.harness.MockAgent`) discovers a connector over a
+real in-memory MCP session and drives reads (inspecting provenance) and the full
+preview → approve / reject action flow — the same sequence the real Agent Layer
+uses.
+
+## Try it without the test suite
+
+```powershell
+# read path + classification + provenance, over a real stdio MCP server
+venv\Scripts\python.exe examples\manual_client.py
+
+# the full preview -> approve -> execute and preview -> reject flow
+venv\Scripts\python.exe examples\manual_action_flow.py
+```
+
+See [`examples/jira_connector/`](examples/jira_connector/) for the full runnable
+connector used in the Phase 1 and Phase 2 tests.
+
+## Versioning & compatibility
+
+The SDK follows [SemVer](https://semver.org); see [CHANGELOG.md](CHANGELOG.md).
+Every connector manifest declares the SDK **major** version it targets, and the
+gateway calls `assert_compatible(manifest)` before loading — refusing a connector
+built against an incompatible major with a clear error. Breaking changes ship
+with a guide in [MIGRATIONS.md](MIGRATIONS.md).
+
+## Release / publishing (maintainers)
+
+Distributions are built with `python -m build` into `dist/`. To publish to PyPI:
+
+```bash
+python -m build                       # build sdist + wheel into dist/
+python -m twine check dist/*          # validate metadata
+python -m twine upload dist/*         # publish (requires PyPI credentials)
+```
+
+Tag the release `v<version>` and ensure `version` in `pyproject.toml` matches
+`SDK_VERSION` (a test enforces this against the installed package).

deepquery_sdk-1.0.0/README.md

@@ -0,0 +1,165 @@
+# DeepQuerySDK — Connector Development Kit
+
+Build connectors for Deep Query. A connector you write with this SDK **emits a
+standard [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server**
+— so Deep Query consumes it through the exact same interface as any public MCP
+server. You never touch JSON-RPC, transport, or schema plumbing.
+
+> **Status: v1.0.0 — all four build phases complete.** Core contracts (Phase 1),
+> the gated **preview → approve → execute / reject** lifecycle + OAuth 2.1 PKCE
+> scaffolding + credential injection (Phase 2), the `deepquery` **CLI** and
+> **mock-agent harness** with the §5/§6/§13 contracts encoded as `validate`
+> checks (Phase 3), and the semver **compatibility contract** + packaging
+> (Phase 4). The SDK contract is at **major version 1**: connectors declaring
+> `sdk_major_version = 1` are loadable by this runtime.
+
+## What you define
+
+A connector is a subclass of `Connector` that declares three things:
+
+| You define | What it is | Gated? |
+|---|---|---|
+| **Resources** | read-only data the agent can retrieve and **cite** | no |
+| **Actions** | operations that change external state | yes (preview → execute) |
+| **Auth** | how the connector authenticates to the external system | n/a |
+
+Every read carries a **provenance envelope** so live data can be cited honestly.
+Every action is tagged `dq.mutates: true` in the emitted MCP server so Deep
+Query's approval gate knows it must be confirmed by a human.
+
+## Install (development)
+
+```powershell
+# from the DeepQuerySDK/ folder, using the bundled venv
+venv\Scripts\python.exe -m pip install -e .
+```
+
+## 60-second example
+
+```python
+from deepquery_sdk import Connector, OAuth2Auth, resource, action
+
+class JiraConnector(Connector):
+    name = "jira"
+    version = "0.1.0"
+    description = "Read and act on Jira issues."
+
+    # Declare OAuth 2.1 with least-privilege scopes. The gateway runs/stores the
+    # grant and injects the token; this connector never stores credentials.
+    auth = OAuth2Auth(
+        authorize_endpoint="https://auth.atlassian.com/authorize",
+        token_endpoint="https://auth.atlassian.com/oauth/token",
+        scopes=["read:jira-work", "write:jira-work"],
+    )
+    requires_network = True
+
+    @resource(description="Search Jira issues by text query.",
+              input_schema={"type": "object",
+                            "properties": {"query": {"type": "string"}},
+                            "required": ["query"]})
+    def search_issues(self, query: str):
+        # ... call the real Jira API here ...
+        return [
+            self.cite(
+                {"key": "DQ-431", "summary": "Login flow broken", "status": "In Review"},
+                source_object_id="DQ-431",
+                title_or_label="DQ-431 — Login flow broken",
+                deep_link="https://example.atlassian.net/browse/DQ-431",
+                mutability_note="live status field",
+            )
+        ]
+
+    @action(description="Create a new Jira issue.",
+            input_schema={"type": "object",
+                          "properties": {"project": {"type": "string"},
+                                         "summary": {"type": "string"}},
+                          "required": ["project", "summary"]})
+    def create_issue(self, project: str, summary: str):
+        # only ever called after the approval gate confirms the preview.
+        auth = self.apply_auth()  # headers built from the injected credential
+        return {"created": f"{project}-NEW", "summary": summary}
+
+    @create_issue.preview
+    def _(self, project: str, summary: str) -> str:
+        return f"Will create a new issue in project '{project}' titled '{summary}'."
+```
+
+Emit and serve it as an MCP server (the gateway injects the credential):
+
+```python
+from deepquery_sdk import Credential, static_credential_provider
+from deepquery_sdk.mcp_emit import run_stdio
+
+connector = JiraConnector()
+connector.set_credential_provider(static_credential_provider(Credential(token="...")))
+run_stdio(connector)
+```
+
+## The gated action lifecycle
+
+Calling an action does **not** execute it. It returns a preview and a single-use
+approval token; the gateway drives the decision through two control tools:
+
+```
+call create_issue(args)        -> { status: "preview", approval_token, preview, arguments }
+call dq.execute_action(token)  -> runs execute() for exactly those args  (after human approval)
+call dq.reject_action(token)   -> discards the action; it never runs
+```
+
+The token binds the previewed arguments, so execute can never drift from what the
+human approved, and a rejected/used token can never run.
+
+## The `deepquery` CLI
+
+```bash
+deepquery scaffold acme-crm           # generate a new connector from the template
+deepquery validate connector.py       # enforce the §5/§6/§13 safety contracts
+deepquery manifest connector.py       # print/export the connector manifest
+deepquery run-dev connector.py        # drive it interactively with the mock agent
+deepquery emit connector.py --out dist/   # produce the deployable MCP server artifact
+```
+
+A target can be a `path/to/connector.py`, a directory containing `connector.py`,
+or a `module.path:ClassName`. `validate` is the gatekeeper: it statically scans
+`@resource` bodies for mutating calls and **fails a resource that writes** (a
+misclassified action), plus checks descriptions, manifest, deployment honesty,
+and least-privilege scopes.
+
+The dev harness (`deepquery_sdk.harness.MockAgent`) discovers a connector over a
+real in-memory MCP session and drives reads (inspecting provenance) and the full
+preview → approve / reject action flow — the same sequence the real Agent Layer
+uses.
+
+## Try it without the test suite
+
+```powershell
+# read path + classification + provenance, over a real stdio MCP server
+venv\Scripts\python.exe examples\manual_client.py
+
+# the full preview -> approve -> execute and preview -> reject flow
+venv\Scripts\python.exe examples\manual_action_flow.py
+```
+
+See [`examples/jira_connector/`](examples/jira_connector/) for the full runnable
+connector used in the Phase 1 and Phase 2 tests.
+
+## Versioning & compatibility
+
+The SDK follows [SemVer](https://semver.org); see [CHANGELOG.md](CHANGELOG.md).
+Every connector manifest declares the SDK **major** version it targets, and the
+gateway calls `assert_compatible(manifest)` before loading — refusing a connector
+built against an incompatible major with a clear error. Breaking changes ship
+with a guide in [MIGRATIONS.md](MIGRATIONS.md).
+
+## Release / publishing (maintainers)
+
+Distributions are built with `python -m build` into `dist/`. To publish to PyPI:
+
+```bash
+python -m build                       # build sdist + wheel into dist/
+python -m twine check dist/*          # validate metadata
+python -m twine upload dist/*         # publish (requires PyPI credentials)
+```
+
+Tag the release `v<version>` and ensure `version` in `pyproject.toml` matches
+`SDK_VERSION` (a test enforces this against the installed package).