From d8dda507ee07f79a3f934eca3afbf24be187d5c4 Mon Sep 17 00:00:00 2001 From: muralx Date: Sun, 17 May 2026 16:03:45 +0100 Subject: [PATCH 1/2] fix: post-0.1.0 packaging, dependency, and release-workflow cleanup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Bundles fixes and improvements discovered after the 0.1.0 release. Packaging: - Scope each package's sdist to its own source (no monorepo tarball; no bleed of tests/, demo/, docs/ between adapter sdists). - Ship Apache-2.0 LICENSE in adapter wheels. - Derive __version__ from installed package metadata across all three packages (no more hardcoded, drift-prone constant). - Align adapter pyproject.toml metadata with the SDK (classifiers, Repository / Changelog URLs). Dependencies: - Tighten authplane-fastmcp floor to fastmcp>=3.2,<4 (was >=2.0, which could resolve to fastmcp 2.x and crash at import — the adapter uses the v3 auth surface). Docs: - Use absolute GitHub URL for the User Guide link so it resolves on PyPI. - Correct the fastmcp demo port (8080, not 8090). CI / release workflow: - Clone the shared conformance catalog into $RUNNER_TEMP to keep it out of the working tree we tag and publish. - Mint a short-lived release-bot App token for the atomic tag/branch push step in release.yml (default GITHUB_TOKEN is rejected by the v* tag ruleset). - Fail fast in release.yml when release-bot secrets are missing. --- .github/workflows/ci.yml | 18 +- .github/workflows/release.yml | 46 ++++- CHANGELOG.md | 8 + authplane-fastmcp/LICENSE | 191 ++++++++++++++++++ authplane-fastmcp/README.md | 2 +- .../authplane_fastmcp/__init__.py | 8 +- authplane-fastmcp/authplane_fastmcp/auth.py | 2 +- authplane-fastmcp/demo/README.md | 4 +- authplane-fastmcp/demo/mcpserver.py | 2 +- authplane-fastmcp/docs/user-guide.md | 2 +- authplane-fastmcp/pyproject.toml | 24 ++- authplane-mcp/LICENSE | 191 ++++++++++++++++++ authplane-mcp/README.md | 2 +- authplane-mcp/authplane_mcp/__init__.py | 8 +- authplane-mcp/pyproject.toml | 19 ++ authplane/README.md | 2 +- authplane/__init__.py | 8 +- pyproject.toml | 13 ++ 18 files changed, 520 insertions(+), 30 deletions(-) create mode 100644 authplane-fastmcp/LICENSE create mode 100644 authplane-mcp/LICENSE diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c0aa952..8d533ef 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,15 +22,15 @@ jobs: uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 # AuthPlane/conformance is the public sibling repo carrying the shared - # oauth-sdk-conformance-catalog.yaml. Without it, conformance-tests - # cannot run. - - name: Check out shared conformance catalog + # oauth-sdk-conformance-catalog.yaml. Cloned to $RUNNER_TEMP — outside + # $GITHUB_WORKSPACE — so the catalog stays out of the working tree, + # matching release.yml's invariant. Plain git clone is enough: + # actions/checkout disallows paths outside the workspace, and we don't + # need its auth/persist-credentials features for a public read-only repo. + - name: Clone shared conformance catalog (out of tree) if: matrix.package == 'root' - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - with: - repository: AuthPlane/conformance - path: conformance - fetch-depth: 1 + run: | + git clone --depth 1 https://github.com/AuthPlane/conformance.git "$RUNNER_TEMP/conformance" - name: Setup Python uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 @@ -74,7 +74,7 @@ jobs: - name: Test and coverage env: - CONFORMANCE_CATALOG_PATH: ${{ github.workspace }}/conformance/oauth-sdk-conformance-catalog.yaml + CONFORMANCE_CATALOG_PATH: ${{ runner.temp }}/conformance/oauth-sdk-conformance-catalog.yaml run: | if [ "${{ matrix.package }}" = "root" ]; then coverage run -m pytest tests conformance-tests && coverage report diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e948c1c..d800fcf 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -53,21 +53,46 @@ jobs: fi echo "Dispatched from $ref" + # Fail fast if the AuthPlane Release Bot App secrets aren't available + # (e.g. a fork or unconfigured clone). The token-mint step would + # otherwise fail with a generic actions/create-github-app-token error. + - name: Refuse if Release Bot secrets are missing + env: + APP_ID: ${{ secrets.RELEASE_BOT_APP_ID }} + PRIVATE_KEY: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }} + run: | + if [[ -z "$APP_ID" || -z "$PRIVATE_KEY" ]]; then + echo "::error::Release Bot App secrets (RELEASE_BOT_APP_ID / RELEASE_BOT_PRIVATE_KEY) are unavailable in this run. They live as AuthPlane org secrets scoped to the OSS release repo; forks and unconfigured clones cannot run release.yml end-to-end and must follow the manual tagging fallback." + exit 1 + fi + + # Tag/branch rulesets reject GHA bot pushes for v* tags. Mint a + # short-lived installation token for the AuthPlane Release Bot App + # (bypass actor on the ruleset) and pass it to checkout so the + # atomic push and source-branch delete use the App's identity. + - name: Mint release-bot token + id: app_token + uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 + with: + app-id: ${{ secrets.RELEASE_BOT_APP_ID }} + private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }} + - name: Check out repo with full history and all tags uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 ref: ${{ github.ref }} + token: ${{ steps.app_token.outputs.token }} # AuthPlane/conformance is the public sibling repo carrying the shared - # oauth-sdk-conformance-catalog.yaml. Without it, conformance-tests - # cannot run. - - name: Check out shared conformance catalog - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - with: - repository: AuthPlane/conformance - path: conformance - fetch-depth: 1 + # oauth-sdk-conformance-catalog.yaml. Cloned to $RUNNER_TEMP — outside + # $GITHUB_WORKSPACE — so the catalog checkout never pollutes the working + # tree of the commit we tag and publish. Plain git clone is enough: + # actions/checkout disallows paths outside the workspace, and we don't + # need its auth/persist-credentials features for a public read-only repo. + - name: Clone shared conformance catalog (out of tree) + run: | + git clone --depth 1 https://github.com/AuthPlane/conformance.git "$RUNNER_TEMP/conformance" - name: Set up Python 3.11 uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 @@ -148,7 +173,7 @@ jobs: # below, as part of the single release commit. - name: Install packages and run tests env: - CONFORMANCE_CATALOG_PATH: ${{ github.workspace }}/conformance/oauth-sdk-conformance-catalog.yaml + CONFORMANCE_CATALOG_PATH: ${{ runner.temp }}/conformance/oauth-sdk-conformance-catalog.yaml run: | pip install -e ".[dev]" pip install -e "./authplane-mcp[dev]" @@ -231,6 +256,9 @@ jobs: echo "See CHANGELOG.md for details." >> /tmp/release-notes.md fi + # GitHub Release creation goes through the API, not git push, so the + # default GITHUB_TOKEN is sufficient — the Release Bot App token is + # only needed for the tag/branch push and source-branch delete above. - name: Create GitHub Release if: ${{ !inputs.dryRun }} env: diff --git a/CHANGELOG.md b/CHANGELOG.md index 9bbf422..b75e2fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Fixed +- Packaging issues discovered after the first release. +- Documentation links and demo references. +- `authplane-fastmcp` dependency range now correctly requires `fastmcp>=3.2,<4` (was `>=2.0`, which could resolve to a version the adapter can't import). + +### Changed +- CI and release workflow improvements from first-release learnings. + ## [0.1.0] - 2026-05-11 - Initial release. diff --git a/authplane-fastmcp/LICENSE b/authplane-fastmcp/LICENSE new file mode 100644 index 0000000..c93295a --- /dev/null +++ b/authplane-fastmcp/LICENSE @@ -0,0 +1,191 @@ + + 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 the 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 the 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 any notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + 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 + + Copyright 2025 AuthPlane + + 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. diff --git a/authplane-fastmcp/README.md b/authplane-fastmcp/README.md index 13c203c..310db36 100644 --- a/authplane-fastmcp/README.md +++ b/authplane-fastmcp/README.md @@ -48,4 +48,4 @@ asyncio.run(main()) ## Documentation -PRM behavior, dev mode, revocation checking, manual setup, scope enforcement semantics, claim access, the full `authplane_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](docs/user-guide.md)**. +PRM behavior, dev mode, revocation checking, manual setup, scope enforcement semantics, claim access, the full `authplane_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](https://github.com/AuthPlane/python-sdk/blob/main/authplane-fastmcp/docs/user-guide.md)**. diff --git a/authplane-fastmcp/authplane_fastmcp/__init__.py b/authplane-fastmcp/authplane_fastmcp/__init__.py index 6c8e59d..849e3f9 100644 --- a/authplane-fastmcp/authplane_fastmcp/__init__.py +++ b/authplane-fastmcp/authplane_fastmcp/__init__.py @@ -8,7 +8,13 @@ exports only the adapter-owned glue. """ -__version__ = "0.1.0" +from importlib.metadata import PackageNotFoundError as _PackageNotFoundError +from importlib.metadata import version as _version + +try: + __version__ = _version("authplane-fastmcp") +except _PackageNotFoundError: # pragma: no cover - source tree without an install + __version__ = "0.0.0+unknown" from .auth import AuthplaneAuthResult, authplane_auth from .url_elicitation import to_url_elicitation_required_error diff --git a/authplane-fastmcp/authplane_fastmcp/auth.py b/authplane-fastmcp/authplane_fastmcp/auth.py index 1e20c81..16e31a8 100644 --- a/authplane-fastmcp/authplane_fastmcp/auth.py +++ b/authplane-fastmcp/authplane_fastmcp/auth.py @@ -265,7 +265,7 @@ async def authplane_auth( ) # Wrap in AuthplaneTokenVerifier - # Note: FastMCP 3.0.0 uses token_verifier.base_url for PRM generation if provided + # Note: FastMCP uses token_verifier.base_url for PRM generation if provided token_verifier = AuthplaneTokenVerifier(verifier, base_url=base_url) # Wrap in RemoteAuthProvider to get PRM routes diff --git a/authplane-fastmcp/demo/README.md b/authplane-fastmcp/demo/README.md index 9c82262..5e4f8d2 100644 --- a/authplane-fastmcp/demo/README.md +++ b/authplane-fastmcp/demo/README.md @@ -29,14 +29,14 @@ cd authplane-fastmcp ./demo/run.sh ``` -`run.sh` creates a virtualenv, installs dependencies, and starts the server on port `8090`. All demo credentials are pre-configured — no additional setup needed. +`run.sh` creates a virtualenv, installs dependencies, and starts the server on port `8080`. All demo credentials are pre-configured — no additional setup needed. ## How it works Note that FastMCP filters tools if the scope is not available. ``` -MCP Client ──Bearer JWT──► mcpserver.py (port 8090) +MCP Client ──Bearer JWT──► mcpserver.py (port 8080) │ ├─ authplane_auth() │ • Discovers JWKS from ISSUER_URL diff --git a/authplane-fastmcp/demo/mcpserver.py b/authplane-fastmcp/demo/mcpserver.py index fc3eb15..58a89d1 100644 --- a/authplane-fastmcp/demo/mcpserver.py +++ b/authplane-fastmcp/demo/mcpserver.py @@ -59,7 +59,7 @@ def multiply(a: float, b: float) -> float: return a * b # NOTE: a ``consent_demo`` tool that exercises the URL elicitation path - # was intentionally omitted from this demo. fastmcp 3.2.4 does not + # was intentionally omitted from this demo. fastmcp 3.2 does not # propagate ``UrlElicitationRequiredError`` (an ``McpError`` subclass) # raised inside a tool handler — its tool-call dispatch catches only # ``FastMCPError`` and wraps everything else as an ``isError: true`` diff --git a/authplane-fastmcp/docs/user-guide.md b/authplane-fastmcp/docs/user-guide.md index 63aecd4..b888c7e 100644 --- a/authplane-fastmcp/docs/user-guide.md +++ b/authplane-fastmcp/docs/user-guide.md @@ -274,7 +274,7 @@ downstream = await result.client.exchange( When a token exchange needs interactive user consent at the AS (for example, first-time authorization against a third-party service), the AS returns `consent_required` with a `consent_url`. MCP surfaces this through the URL elicitation flow (JSON-RPC error `-32042`). The [`authplane-mcp`](../../authplane-mcp/docs/user-guide.md#url-elicitation-for-consent) adapter wires it up end-to-end. -**fastmcp 3.2.4 does not propagate `McpError` from tool handlers** (its tool dispatch wraps everything except `FastMCPError` as `{"isError": true}`), so `-32042` never reaches the wire. Handle `ConsentRequiredError` in the tool body for now: +**fastmcp 3.2 does not propagate `McpError` from tool handlers** (its tool dispatch wraps everything except `FastMCPError` as `{"isError": true}`), so `-32042` never reaches the wire. Handle `ConsentRequiredError` in the tool body for now: ```python from authplane import ConsentRequiredError diff --git a/authplane-fastmcp/pyproject.toml b/authplane-fastmcp/pyproject.toml index 18909e7..1572eb3 100644 --- a/authplane-fastmcp/pyproject.toml +++ b/authplane-fastmcp/pyproject.toml @@ -12,16 +12,32 @@ authors = [ { name = "Authplane Team" } ] keywords = ["oauth", "jwt", "fastmcp", "adapter", "authplane"] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Topic :: Security", + "Topic :: Software Development :: Libraries :: Python Modules", +] requires-python = ">=3.11" dependencies = [ "authplane-sdk", - "fastmcp>=2.0", + # Upper bound on 4.x is anticipatory — when fastmcp 4 ships we need to + # re-verify the `FastMCP` constructor + `fastmcp.server.auth.require_scopes` + # surface the adapter consumes. + "fastmcp>=3.2,<4", "pydantic>=2.0", ] [project.urls] Homepage = "https://github.com/AuthPlane/python-sdk/tree/main/authplane-fastmcp" +Repository = "https://github.com/AuthPlane/python-sdk" Issues = "https://github.com/AuthPlane/python-sdk/issues" +Changelog = "https://github.com/AuthPlane/python-sdk/blob/main/CHANGELOG.md" [project.optional-dependencies] dev = [ @@ -87,3 +103,9 @@ indent-style = "space" [tool.hatch.version] source = "vcs" raw-options.root = ".." + +# Keep the sdist to this package's source. Hatchling's default would also +# tarball tests/, demo/, docs/ and dotfiles from this directory. +# pyproject.toml, README.md and LICENSE are included automatically. +[tool.hatch.build.targets.sdist] +only-include = ["authplane_fastmcp"] diff --git a/authplane-mcp/LICENSE b/authplane-mcp/LICENSE new file mode 100644 index 0000000..c93295a --- /dev/null +++ b/authplane-mcp/LICENSE @@ -0,0 +1,191 @@ + + 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 the 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 the 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 any notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + 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 + + Copyright 2025 AuthPlane + + 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. diff --git a/authplane-mcp/README.md b/authplane-mcp/README.md index 2aaf741..e658103 100644 --- a/authplane-mcp/README.md +++ b/authplane-mcp/README.md @@ -43,4 +43,4 @@ mcp.run(transport="streamable-http") ## Documentation -PRM behavior, dev mode, revocation checking, manual setup, the full `authplane_mcp_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](docs/user-guide.md)**. +PRM behavior, dev mode, revocation checking, manual setup, the full `authplane_mcp_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](https://github.com/AuthPlane/python-sdk/blob/main/authplane-mcp/docs/user-guide.md)**. diff --git a/authplane-mcp/authplane_mcp/__init__.py b/authplane-mcp/authplane_mcp/__init__.py index 3c1a232..ce15b3d 100644 --- a/authplane-mcp/authplane_mcp/__init__.py +++ b/authplane-mcp/authplane_mcp/__init__.py @@ -9,7 +9,13 @@ exports only the adapter-owned glue. """ -__version__ = "0.1.0" +from importlib.metadata import PackageNotFoundError as _PackageNotFoundError +from importlib.metadata import version as _version + +try: + __version__ = _version("authplane-mcp") +except _PackageNotFoundError: # pragma: no cover - source tree without an install + __version__ = "0.0.0+unknown" from .auth import AuthplaneAuthResult, authplane_mcp_auth, require_scope from .url_elicitation import to_url_elicitation_required_error diff --git a/authplane-mcp/pyproject.toml b/authplane-mcp/pyproject.toml index 7dbc6e4..7b29aa4 100644 --- a/authplane-mcp/pyproject.toml +++ b/authplane-mcp/pyproject.toml @@ -12,6 +12,17 @@ authors = [ { name = "Authplane Team" } ] keywords = ["oauth", "jwt", "mcp", "adapter", "authplane"] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Topic :: Security", + "Topic :: Software Development :: Libraries :: Python Modules", +] requires-python = ">=3.11" dependencies = [ "authplane-sdk", @@ -23,7 +34,9 @@ dependencies = [ [project.urls] Homepage = "https://github.com/AuthPlane/python-sdk/tree/main/authplane-mcp" +Repository = "https://github.com/AuthPlane/python-sdk" Issues = "https://github.com/AuthPlane/python-sdk/issues" +Changelog = "https://github.com/AuthPlane/python-sdk/blob/main/CHANGELOG.md" [project.optional-dependencies] dev = [ @@ -89,3 +102,9 @@ indent-style = "space" [tool.hatch.version] source = "vcs" raw-options.root = ".." + +# Keep the sdist to this package's source. Hatchling's default would also +# tarball tests/, demo/, docs/ and dotfiles from this directory. +# pyproject.toml, README.md and LICENSE are included automatically. +[tool.hatch.build.targets.sdist] +only-include = ["authplane_mcp"] diff --git a/authplane/README.md b/authplane/README.md index 06b9af5..6604502 100644 --- a/authplane/README.md +++ b/authplane/README.md @@ -43,4 +43,4 @@ Call `await client.aclose()` on shutdown to stop background JWKS and metadata re ## Documentation -Full API reference, configuration options, error hierarchy, DPoP, token operations, introspection, token exchange, and advanced usage: **[User Guide](docs/user-guide.md)**. +Full API reference, configuration options, error hierarchy, DPoP, token operations, introspection, token exchange, and advanced usage: **[User Guide](https://github.com/AuthPlane/python-sdk/blob/main/authplane/docs/user-guide.md)**. diff --git a/authplane/__init__.py b/authplane/__init__.py index af6c34e..5ef5504 100644 --- a/authplane/__init__.py +++ b/authplane/__init__.py @@ -1,6 +1,12 @@ """Authplane Python SDK — OAuth 2.1 JWT validation and token operations for protected resources.""" -__version__ = "0.1.0" +from importlib.metadata import PackageNotFoundError as _PackageNotFoundError +from importlib.metadata import version as _version + +try: + __version__ = _version("authplane-sdk") +except _PackageNotFoundError: # pragma: no cover - source tree without an install + __version__ = "0.0.0+unknown" # Client # Authentication diff --git a/pyproject.toml b/pyproject.toml index 3f9ceb8..d7e1a0e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,10 +43,23 @@ dev = [ [project.urls] Homepage = "https://github.com/AuthPlane/python-sdk" +Repository = "https://github.com/AuthPlane/python-sdk" Issues = "https://github.com/AuthPlane/python-sdk/issues" +Changelog = "https://github.com/AuthPlane/python-sdk/blob/main/CHANGELOG.md" [tool.hatch.build.targets.wheel] packages = ["authplane"] +# The package README is referenced by ``project.readme`` and ships in the +# wheel because it lives inside ``authplane/``. The user guide is large, +# import-irrelevant prose — keep it in the sdist, not the installed wheel. +exclude = ["authplane/docs"] + +# Without this, hatchling's default sdist behaviour ("everything tracked by +# VCS under the build root") tarballs the whole monorepo into authplane-sdk. +# Scope it to the package itself; pyproject.toml, authplane/README.md (the +# ``project.readme``) and LICENSE are always included automatically. +[tool.hatch.build.targets.sdist] +only-include = ["authplane", "CHANGELOG.md"] [tool.pytest.ini_options] asyncio_mode = "auto" From bbf0e2b7d8de0489fccf583515b776496ec6460e Mon Sep 17 00:00:00 2001 From: muralx Date: Sun, 17 May 2026 21:39:51 +0100 Subject: [PATCH 2/2] docs(authplane-mcp): enforce scope in README quickstart example The Quickstart used a bare @mcp.tool() while passing scopes=[...] to authplane_mcp_auth, implying enforcement that never happened. --- authplane-mcp/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/authplane-mcp/README.md b/authplane-mcp/README.md index e658103..3a1df1b 100644 --- a/authplane-mcp/README.md +++ b/authplane-mcp/README.md @@ -19,7 +19,7 @@ Supported `mcp` range: **`>=1.23.0, <1.28.0`**. MCP 1.28 renamed the elicitation ```python import asyncio -from authplane_mcp import authplane_mcp_auth +from authplane_mcp import authplane_mcp_auth, require_scope from mcp.server.fastmcp import FastMCP auth_result = asyncio.run( @@ -34,6 +34,7 @@ mcp = FastMCP("My MCP Server", json_response=True, **auth_result) @mcp.tool() async def query_database(query: str) -> str: + require_scope("tools/query") return f"Result for: {query}" mcp.run(transport="streamable-http")