contexture-mcp 1.0.0__tar.gz

contexture_mcp-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

contexture_mcp-1.0.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: contexture-mcp
+Version: 1.0.0
+Summary: A Controller framework for agent and human Views: declare once, then publish through MCP and explicit REST routes
+Keywords: agent,context,controller,mcp,rest,asgi,llm,claude-code,codex
+Author: Contexture
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Dist: anyio>=4.5,<5
+Requires-Dist: mcp>=2.1.1,<3
+Requires-Dist: mcp-types>=2.1.1,<3
+Requires-Dist: build>=1.3,<2 ; extra == 'dev'
+Requires-Dist: mcp[cli]>=2.1.1,<3 ; extra == 'dev'
+Requires-Dist: pyright>=1.1.405,<2 ; extra == 'dev'
+Requires-Dist: pytest>=8,<10 ; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1,<2 ; extra == 'dev'
+Requires-Dist: ruff>=0.12,<1 ; extra == 'dev'
+Requires-Dist: twine>=6,<7 ; extra == 'dev'
+Requires-Dist: validate-pyproject[all]>=0.24,<1 ; extra == 'dev'
+Maintainer: CarterShi01
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/CarterShi01/contexture-mcp
+Project-URL: Documentation, https://github.com/CarterShi01/contexture-mcp/blob/master/docs/handbook.md
+Project-URL: Repository, https://github.com/CarterShi01/contexture-mcp
+Project-URL: Issues, https://github.com/CarterShi01/contexture-mcp/issues
+Project-URL: Changelog, https://github.com/CarterShi01/contexture-mcp/blob/master/CHANGELOG.md
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# Contexture
+
+[简体中文](README.zh-CN.md) · [Handbook](docs/handbook.md) · [Specification](spec/README.md) · [Changelog](CHANGELOG.md)
+
+Implementations: Python (this repository) ·
+[TypeScript](https://github.com/CarterShi01/contexture-mcp-typescript) ·
+[Go](https://github.com/CarterShi01/contexture-mcp-go)
+
+Contexture is a Python framework for exposing a large application capability
+graph to agents without placing every tool and instruction in the model's
+context at once. You declare Roles, Skills, and Tools; Contexture compiles an
+immutable graph and serves a small, fixed MCP gateway that discloses only the
+branch an agent chooses.
+
+The same application runtime can back explicit REST routes for human
+interfaces. Contexture is a Controller layer: it does not contain an agent
+loop, call a model, or replace your business services.
+
+- Python 3.11–3.14
+- MCP stdio and Streamable HTTP
+- Typed and marked with `py.typed`
+- Apache-2.0
+- Stable 1.0 public API governed by Semantic Versioning
+
+## Install
+
+With [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install contexture-mcp
+contexture --version
+```
+
+Or add it to a Python project:
+
+```bash
+uv add contexture-mcp
+# or: python -m pip install contexture-mcp
+```
+
+To pin this release, request `contexture-mcp==1.0.0`.
+
+## Five-minute application
+
+```bash
+contexture new hello-context
+cd hello-context
+uv sync
+uv run contexture check
+```
+
+The authoring model is deliberately small:
+
+```python
+from contexture import Contexture, Role, Skill, Tool
+
+
+class CheckStatus(Tool):
+    def __init__(self) -> None:
+        super().__init__(
+            name="check-status",
+            description="Return the status of one service.",
+            read_only=True,
+        )
+
+    async def invoke(self, service: str) -> dict[str, str]:
+        return {"service": service, "status": "ready"}
+
+
+class Diagnose(Skill):
+    def __init__(self) -> None:
+        super().__init__(
+            name="diagnose",
+            description="Diagnose an unhealthy service.",
+            instructions="Read status first, then explain the evidence.",
+            uses=("operations/check-status",),
+        )
+
+
+class Operations(Role):
+    def __init__(self) -> None:
+        super().__init__(
+            name="operations",
+            description="Handle service operations.",
+            instructions="Inspect before proposing a change.",
+            skills=[Diagnose()],
+            tools=[CheckStatus()],
+        )
+
+
+app = Contexture(name="service-operations", roots=(Operations,))
+```
+
+Contexture never infers public names or descriptions from class names or
+docstrings. A Tool's `invoke()` type hints produce its input schema and validate
+the same call, so schema and runtime cannot drift independently.
+
+## Development loop
+
+```bash
+uv run contexture check
+uv run contexture list
+uv run contexture inspect operations/diagnose
+uv run contexture call operations/check-status --input '{"service":"api"}'
+uv run contexture serve
+```
+
+`check` validates without opening external connections. `list` shows canonical
+refs. `inspect` replays what an agent will receive. `call` executes a local
+read-only Tool through the production binding; writing Tools require an
+explicit `--allow-write`.
+
+## One declaration vocabulary
+
+| Concept | What you write | Meaning |
+| --- | --- | --- |
+| `Contexture` | one application value | Lazy composition root |
+| `Role` | subclass + constructor | Responsibility and containment boundary |
+| `PreProcess` / `PostProcess` | specialized Roles + constructors | Optional preparation and finishing procedures with dedicated capabilities |
+| `Skill` | subclass + constructor | Procedure the model follows |
+| `Tool` | subclass + typed `invoke()` | Deterministic code Contexture executes |
+| `Prompt` | subclass + constructor | User-triggered entrance to an existing node |
+| `Resource` | subclass + constructor | Host-readable URI backed by a read-only Tool |
+| `Channels` | optional subclass | Shared external dependencies and lifecycle |
+
+Role, Skill, and Tool form the graph. Prompt and Resource provide another
+protocol entrance to a ref the graph already owns. Use `prompt_roots` for
+complete trees that only the user-controlled Prompt plane may enter.
+
+The stable 1.0 API lets a Role hold optional `pre_process` and
+`post_process` Roles. ACTIVE composes fixed, recognizable framework instruction
+blocks around unchanged business `Role.instructions`, naming the actual refs to
+open before starting or finishing. Procedures stay hidden until opened; opening
+executes nothing and never bypasses approval. With both fields absent, existing
+output and obligations are unchanged. Applications may also use
+`binding_instruction` to mark their own non-enforceable hard rules under their
+own authority. See the [authoring example](docs/handbook.md#optional-process-members-python-0160)
+and [ADR 023](docs/adr/023-process-members-and-instruction-emphasis.md).
+
+## Progressive disclosure
+
+MCP hosts always see five fixed model-controlled tools:
+
+```text
+contexture_discover
+contexture_inspect
+contexture_open
+contexture_invoke_read_only
+contexture_invoke
+```
+
+`discover` returns root cards. `inspect` compares a shortlist through one level
+of pure routing cards without activating instructions or disclosing Tool
+schemas. Opening a Role returns its instructions and one
+level of child Role, Skill, and Tool cards. A Tool card carries the ref, input
+schema, and read-only classification needed to invoke it. Business Tools never
+inflate MCP's top-level tool list.
+
+The two invoke doors let a host apply approval policy from the visible MCP
+`readOnlyHint`. Calling through the wrong door is refused. Disclosure helps a
+model decide what exists; it is not authorization.
+
+## Connect an MCP host
+
+After local checks pass, let the host own the stdio process:
+
+```bash
+claude mcp add --scope project hello-context -- uv run contexture serve
+codex mcp add                 hello-context -- uv run contexture serve
+```
+
+For Streamable HTTP:
+
+```bash
+uv run contexture serve --transport streamable-http --port 8080
+```
+
+Non-loopback HTTP requires an explicit authentication or anonymous-access
+decision plus allowed hosts/origins. Configure these with `ContextureOptions`.
+See the [handbook](docs/handbook.md).
+
+An HTTP deployment can attenuate a request to complete subtrees with the
+`Contexture-Select` header and `HeaderSurfaceSelector`. Exact refs such as
+`team/notebook-editor` select that complete subtree; `team/*` selects each
+direct member subtree, and `*` never crosses `/`. The legacy
+`Contexture-Roots` and `HeaderRootSelector` names remain compatible. An
+application-owned ceiling derived from the verified `Principal` can restrict
+the selection further. Selection is a surface boundary, not permission policy.
+
+```python
+from contexture.server import HeaderSurfaceSelector, compile_application
+
+server = compile_application(app).server(
+    surface_selector=HeaderSurfaceSelector(),
+)
+```
+
+## Human-facing REST routes
+
+An agent benefits from navigation; a dashboard has already chosen its pages
+and buttons. Expose an explicit Tool allowlist:
+
+```python
+from contexture.server import compile_application
+from contexture.web import RestSurface, Route
+from my_context import app
+
+compiled = compile_application(app)
+rest = RestSurface(
+    compiled.runtime(),
+    routes=(Route("GET", "/v1/status", "operations/check-status"),),
+)
+asgi_app = rest.asgi_app()
+```
+
+GET/HEAD routes may target only read-only Tools. Writing routes may target only
+writing Tools. Unlisted refs are unreachable through REST.
+
+## Public API
+
+Use `contexture` for declarations and `contexture.server` for advanced hosting.
+Their export sets are regression-tested. `contexture.core` and concrete server
+submodules are implementation details even though Python can import them.
+
+## Work on Contexture
+
+```bash
+git clone https://github.com/CarterShi01/contexture-mcp.git
+cd contexture-mcp
+uv sync --extra dev
+uv run --extra dev pytest -q
+uv run --extra dev pyright
+uv run --extra dev ruff check contexture tests
+uv build
+uv run --extra dev twine check --strict dist/*
+```
+
+Read the [contribution guide](CONTRIBUTING.md) before changing a contract, the
+[handbook](docs/handbook.md) for application development, and the
+[language-neutral specification](spec/README.md) when implementing another
+binding. Report vulnerabilities according to [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).