aviary-mcp 0.1.0rc1__tar.gz

aviary_mcp-0.1.0rc1/.dockerignore

@@ -0,0 +1,9 @@
+.git
+.github
+.pytest_cache
+.venv
+**/__pycache__
+**/*.py[cod]
+dist
+build
+*.egg-info

aviary_mcp-0.1.0rc1/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+env:
+  UV_VERSION: 0.11.2
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install locked build frontend
+        run: python -m pip install "uv==$UV_VERSION"
+      - name: Verify lock and install
+        run: |
+          uv lock --check
+          uv sync --frozen --extra test
+      - run: uv run pytest
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+        with:
+          python-version: "3.12"
+      - run: python -m pip install "uv==$UV_VERSION"
+      - run: uv lock --check
+      - name: Verify release helper scripts
+        run: |
+          sh -n scripts/*.sh
+          scripts/dependency-lock-sha256.sh "$(scripts/dependency-lock-sha256.sh)"
+          scripts/verify-image-reference.sh \
+            registry.example/aviary@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+      - run: uv build
+      - name: Validate sidecar Compose model
+        run: FINCH_TENANT=ci-tenant docker compose -f examples/docker-compose/compose.yml config --quiet
+      - name: Build non-root reference image with lock checksum gate
+        run: |
+          lock_sha=$(scripts/dependency-lock-sha256.sh)
+          docker build --build-arg "AVIARY_LOCK_SHA256=$lock_sha" -t aviary-mcp:test .
+          test "$(docker run --rm --entrypoint id aviary-mcp:test -u)" = "10002"

aviary_mcp-0.1.0rc1/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install "uv==0.11.2"
+      - run: uv lock --check
+      - run: uv sync --frozen --extra test
+      - run: uv run pytest -q
+      - run: uv build
+      - name: Write release checksums
+        run: cd dist && sha256sum * > SHA256SUMS
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

aviary_mcp-0.1.0rc1/.gitignore

@@ -0,0 +1,4 @@
+.venv/
+__pycache__/
+.pytest_cache/
+*.egg-info/

aviary_mcp-0.1.0rc1/Dockerfile

@@ -0,0 +1,55 @@
+# syntax=docker/dockerfile:1.7
+
+# Override these with digest-pinned references in release builds, for example:
+#   --build-arg PYTHON_BUILD_IMAGE=python:3.12.11-slim-bookworm@sha256:...
+#   --build-arg PYTHON_RUNTIME_IMAGE=python:3.12.11-slim-bookworm@sha256:...
+ARG PYTHON_BUILD_IMAGE=python:3.12.11-slim-bookworm
+ARG PYTHON_RUNTIME_IMAGE=python:3.12.11-slim-bookworm
+ARG UV_IMAGE=ghcr.io/astral-sh/uv:0.11.2
+
+FROM ${UV_IMAGE} AS uv
+FROM ${PYTHON_BUILD_IMAGE} AS build
+
+ARG AVIARY_LOCK_SHA256=""
+ENV UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy \
+    UV_PROJECT_ENVIRONMENT=/opt/aviary-venv
+WORKDIR /build
+
+# uv.lock contains artifact hashes. AVIARY_LOCK_SHA256 is an optional release
+# gate for pinning the complete lock file itself (see scripts/dependency-lock-sha256.sh).
+COPY --from=uv /uv /uvx /bin/
+COPY pyproject.toml uv.lock ./
+RUN if [ -n "${AVIARY_LOCK_SHA256}" ]; then \
+      printf '%s  %s\n' "${AVIARY_LOCK_SHA256}" uv.lock | sha256sum --check --strict -; \
+    fi \
+    && uv sync --frozen --no-dev --no-install-project
+
+COPY README.md LICENSE ./
+COPY src ./src
+RUN uv sync --frozen --no-dev --no-editable \
+    && find /opt/aviary-venv -type d -name __pycache__ -prune -exec rm -rf '{}' +
+
+FROM ${PYTHON_RUNTIME_IMAGE} AS runtime
+
+ARG APP_UID=10002
+ARG APP_GID=10002
+RUN groupadd --gid "${APP_GID}" aviary \
+    && useradd --uid "${APP_UID}" --gid "${APP_GID}" \
+      --home-dir /home/aviary --create-home --shell /usr/sbin/nologin aviary
+
+ENV PATH=/opt/aviary-venv/bin:$PATH \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    AVIARY_HOST=0.0.0.0 \
+    AVIARY_PORT=8000
+WORKDIR /app
+
+COPY --from=build /opt/aviary-venv /opt/aviary-venv
+COPY --chown=aviary:aviary examples/container_app.py /app/server.py
+
+USER aviary
+EXPOSE 8000
+HEALTHCHECK --interval=15s --timeout=3s --start-period=10s --retries=3 \
+  CMD ["python", "-c", "import os,urllib.request; urllib.request.urlopen('http://127.0.0.1:'+os.getenv('AVIARY_PORT','8000')+'/birdz/ready', timeout=2).read()"]
+CMD ["python", "/app/server.py"]

aviary_mcp-0.1.0rc1/LICENSE

@@ -0,0 +1,201 @@
+                                 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, 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
+
+   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 DigiBugCat
+
+   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.

aviary_mcp-0.1.0rc1/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: aviary-mcp
+Version: 0.1.0rc1
+Summary: An opinionated FastMCP runtime for authenticated MCP and REST services through Finch
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: anyio<5,>=4.5
+Requires-Dist: fastmcp==3.4.4
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: pyjwt[crypto]<3,>=2.10
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# AviaryMCP
+
+AviaryMCP is a release-candidate, opinionated FastMCP runtime for publishing one
+tool definition through MCP and a generated REST/OpenAPI interface. It extends
+FastMCP through public APIs rather than maintaining a source fork, so MCP and
+HTTP share the same registry, validation, middleware, handler, and authorization
+decision.
+
+```python
+from aviary_mcp import AviaryMCP
+
+app = AviaryMCP("calculator")
+
+@app.tool
+def add(a: int, b: int) -> int:
+    """Add two integers."""
+    return a + b
+
+app.run(transport="http", host="127.0.0.1", port=8000)
+```
+
+`access="local"` is the safe default: HTTP may bind only to loopback, and
+in-process/stdio calls receive a local principal. An unauthenticated network
+service requires explicit `access="public"`. Supplying `auth=` (or a FastMCP
+3.4 token verifier through `mcp_auth=`) selects private mode.
+
+An authenticated REST face uses normalized principals and operation-centric
+scopes:
+
+```python
+from aviary_mcp import AviaryMCP, Principal, StaticKeyAuth
+
+app = AviaryMCP(
+    "calculator",
+    auth=StaticKeyAuth({
+        # Use a generated, high-entropy secret in production. The provider
+        # immediately retains only its SHA-256 digest.
+        "development-secret": Principal(
+            subject="example-client",
+            scopes={"tool:call:add"},
+        ),
+    }),
+)
+```
+
+`LocalAuth`, `StaticKeyAuth`, `FinchAssertionAuth`, `AnyOf`, and `AllOf`
+normalize callers into a `Principal`. One outer ASGI authentication boundary
+protects `/mcp`, generated REST routes, and application custom routes together.
+The generated REST operation calls
+`invoke_tool`, which checks `tool:call:<tool-name>` (plus any scopes registered
+with `require_scopes`) before entering FastMCP's normal validation, middleware,
+and handler path. When application auth is configured, the generated catalog
+and OpenAPI routes also require authentication so they do not disclose a
+private service's capability schema. Custom transports can obtain identical
+policy behavior by supplying their normalized principal to `invoke_tool`.
+
+The HTTP server exposes:
+
+- `POST /mcp` — FastMCP's streamable HTTP MCP transport
+- `GET /api/v1/tools` — tool catalog
+- `POST /api/v1/tools/{tool_name}` — JSON object arguments and a FastMCP
+  `ToolResult` response
+- `GET /api/v1/openapi.json` — generated OpenAPI 3.1 document
+- `GET /birdz` — unauthenticated application liveness
+
+Every non-health HTTP body, including `/mcp`, is bounded to 1 MiB by default
+(`max_json_request_bytes=`). Generated errors use a stable JSON envelope, and
+private OpenAPI documents publish their configured security schemes.
+
+Finch edge identity uses an asymmetric, short-lived caller assertion:
+
+```python
+from aviary_mcp import AviaryMCP, FinchAssertionAuth
+
+app = AviaryMCP(
+    "calculator",
+    auth=FinchAssertionAuth(tenant="andrew", service="calculator"),
+)
+```
+
+The verifier fetches the rotating ES256 public JWKS from
+`https://jwks.finchmcp.com/.well-known/finch-jwks.json` and binds each request
+to its audience, method, exact local path and query, raw body digest, expiry,
+and one-time assertion ID. Multi-process deployments must inject a shared
+atomic replay store; the default replay store is process-local. Finch exposure
+rejects local-trust auth trees and can warm the JWKS before registering ready.
+
+The Finch control client can hold a dynamic registration lease against the
+local Go agent contract:
+
+```python
+from aviary_mcp import FinchClient, Registration
+
+client = FinchClient()
+async with client.maintain(Registration(
+    "calculator",
+    "http://127.0.0.1:8000",
+    routes=("/mcp", "/api/v1"),
+)):
+    ...
+```
+
+The Finch exposure controller supervises the HTTP server, dynamic lease,
+first-run approval, readiness, and shutdown together. Most applications use it
+through `app.run(expose="finch")`; `create_finch_exposure()` is public for async
+supervisors that need explicit lifecycle control.
+
+For a Finch-native application, the runtime now owns that lifecycle directly:
+
+```python
+from aviary_mcp import AviaryMCP, FinchAssertionAuth
+
+app = AviaryMCP(
+    "calculator",
+    access="private",
+    auth=FinchAssertionAuth(tenant="andrew", service="calculator"),
+)
+
+app.run(
+    expose="finch",
+    app_path="calculator",
+    edge_auth="key",          # private default; public is a separate approval
+    enrollment_output="auto", # TTY instructions or one-line container JSON
+)
+```
+
+The app registers `/mcp`, its configured `api_base`, and `/birdz` as one exact
+allowlist. On first run, device approval is the default: the local Finch agent
+generates the proof key and returns only a verification URL, user code, and
+machine fingerprint. The SDK prints that safe prompt, waits while the operator
+approves the exact service, routes, edge mode, and fingerprint, and resumes when
+Finch has atomically saved a service-scoped credential. AviaryMCP never receives
+a device secret, CLI/admin token, join ticket, or refresh credential.
+
+`edge_auth="key"` is private by default. It requires an AviaryMCP app with
+`FinchAssertionAuth`, and the assertion service must match `app_path`.
+`edge_auth="public"` requires an explicitly `access="public"`, unauthenticated
+app plus a separate public-edge confirmation in the browser; the two modes
+cannot be mixed. `/birdz` is process liveness, while `/birdz/ready` returns 200
+only after Finch confirms a live relay.
+
+Try it:
+
+```console
+python -m venv .venv
+.venv/bin/pip install -e '.[test]'
+.venv/bin/python examples/calculator.py
+
+curl http://127.0.0.1:8000/api/v1/tools
+curl -X POST http://127.0.0.1:8000/api/v1/tools/add \
+  -H 'content-type: application/json' -d '{"a": 20, "b": 22}'
+```
+
+## Production containers
+
+The repository includes a multi-stage, non-root reference `Dockerfile` and a
+sidecar Compose deployment under [`examples/docker-compose/`](examples/docker-compose/).
+The default first run is credentialless: start the stack, read the one-line safe
+enrollment event from the app logs, open `verification_uri_complete`, and approve
+the displayed manifest. Finch retains the resulting scoped credential in its
+private persistent state volume, and AviaryMCP pins the approved tenant into its
+assertion verifier before becoming ready. `FINCH_TENANT` is an optional stricter
+account pin, not required configuration. The application receives only a
+dedicated-group Unix control socket and never receives Finch credentials.
+Dependency artifacts are pinned in `uv.lock`; release builds can also gate the
+complete lock with `scripts/dependency-lock-sha256.sh`.
+
+Container liveness and readiness are intentionally separate. `/birdz` shows
+that the app process is serving; `/birdz/ready` stays unavailable through device
+approval and relay startup, then becomes healthy only when the Finch relay is
+live. Orchestrators should gate traffic and rollout completion on readiness.
+
+See [`docs/production.md`](docs/production.md) for release gates, container
+security boundaries, deployment/rollback steps, and the remaining cloud and
+operator decisions.
+
+## Release-candidate boundaries
+
+The runtime deliberately uses FastMCP 3.x public APIs and does not vendor or
+patch FastMCP. FastMCP child servers can be composed with the public live
+`mount()` API; see [`docs/composition.md`](docs/composition.md). REST
+streaming/background tasks and idempotency remain future work. The generated HTTP operation invokes
+`FastMCP.call_tool`, so FastMCP middleware and input validation are shared rather
+than reimplemented.
+
+### Current MCP authentication boundary
+
+FastMCP token verifiers passed as `mcp_auth=` are adapted through their public
+`verify_token()` API and participate in the same outer request boundary as
+Aviary providers. This supports direct bearer JWT/OAuth access without a split
+REST/MCP configuration. The adapter does not mount a FastMCP OAuth provider's
+authorization-server or discovery routes; Finch owns OAuth at the edge for this
+release candidate. Hosted standalone OAuth discovery remains a post-pilot item.
+
+`FinchAssertionAuth` includes a bounded in-process replay cache by default. A
+multi-process or horizontally scaled application must provide an atomic shared
+replay store before production traffic so a one-time assertion cannot be
+accepted by two workers.