motionmcp-sdk 0.1.0__tar.gz

motionmcp_sdk-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+build/
+dist/
+.tox/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.venv/
+venv/
+
+# Editors
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# Docs site (Docusaurus)
+docs/node_modules/
+docs/build/
+docs/.docusaurus/
+docs/.cache-loader/

motionmcp_sdk-0.1.0/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 (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+
+   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.

motionmcp_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: motionmcp-sdk
+Version: 0.1.0
+Summary: Python SDK for MMCP — the Motion Model Context Protocol. Build a vendor-neutral motion-generation server in ~30 lines.
+Project-URL: Homepage, https://animatica.ai/mmcp
+Project-URL: Source, https://github.com/animatica-ai/motionmcp
+Project-URL: Issues, https://github.com/animatica-ai/motionmcp/issues
+Author: MMCP contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,animation,diffusion,gltf,mmcp,motion,skeleton
+Classifier: Development Status :: 3 - Alpha
+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: Topic :: Multimedia :: Graphics :: 3D Modeling
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.110
+Requires-Dist: numpy>=1.24
+Requires-Dist: pydantic>=2.5
+Requires-Dist: uvicorn[standard]>=0.27
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# motionmcp
+
+Python SDK for **MMCP** — the [Motion Model Context Protocol][docs].
+
+Build a vendor-neutral motion-generation HTTP server in ~30 lines: the
+SDK handles wire-format validation, glTF encoding, and the standard
+error envelope; you implement model loading and a single `generate()`
+method.
+
+[docs]: https://animatica.ai/mmcp
+
+## Where this fits
+
+MMCP is a small HTTP protocol; this is the Python SDK that makes
+implementing the server side trivial.
+
+**Officially supported servers** (built on this SDK):
+- **[motionmcp-kimodo](https://github.com/animatica-ai/motionmcp-kimodo)** —
+  the Kimodo SOMA model. Open-source, self-hosted.
+- **MMCP Cloud** — hosted product. Adds skeleton retargeting, managed
+  GPUs, batch generation, multi-tenant auth.
+
+**Officially supported clients:**
+- **[Proscenium for Blender](https://github.com/animatica-ai/proscenium-blender)** —
+  directable motion generation in Blender 4.2+. Talks to any MMCP server.
+
+Want to add another model or DCC? The protocol is yours to implement —
+this SDK just makes the server side easy. See
+[Servers & clients](https://animatica.ai/mmcp/docs/get-started/implementations)
+for the full list and how to build your own.
+
+```python
+from motionmcp import Backbone, ModelSpec, GenerateRequest, MotionResult, serve
+
+class MyBackbone(Backbone):
+    def capabilities(self) -> ModelSpec:
+        return ModelSpec(
+            id="my-model",
+            fps=30.0,
+            canonical_skeleton=load_skeleton(),
+            supports_retargeting=False,
+            supported_constraints=["pose_keyframe"],
+        )
+
+    async def generate(self, req: GenerateRequest) -> MotionResult:
+        rotations    = self.model.run(req)        # (N, T, J, 4) (x,y,z,w)
+        translations = self.model.run_root(req)   # (N, T, 3)
+        return MotionResult(
+            rotations=rotations,
+            root_translations=translations,
+        )
+
+if __name__ == "__main__":
+    serve(MyBackbone())
+```
+
+That's the whole server. Hit `GET /capabilities` to discover the model;
+`POST /generate` to run it. Returns standard glTF 2.0 — load it with
+any glTF parser.
+
+## Install
+
+```bash
+pip install motionmcp-sdk
+```
+
+Requires Python 3.10+.
+
+## What the SDK gives you
+
+* **Schemas**: Pydantic models for the full wire format
+  (`Skeleton`, `Segment`, `Constraint`, `Options`, `GenerateRequest`).
+  Free validation, IDE autocomplete, OpenAPI docs at `/docs`.
+* **Endpoints**: `GET /capabilities`, `POST /generate`, plus a generic
+  exception → MMCP error envelope handler.
+* **Generic checks**: unknown model, unknown joint in constraint,
+  frame-out-of-range, retargeting policy, constraint count, prompt length,
+  duration limit. All raise the right `error.code`.
+* **glTF encoder**: numpy arrays in, glTF 2.0 JSON out, with the
+  `MMCP_motion` extension correctly populated.
+* **Reference impl**: `NullBackbone` returns a rest pose for any request.
+  Useful for plugin development against a real server with zero ML deps.
+
+## What you implement
+
+* `Backbone.capabilities() -> ModelSpec` — what model you serve.
+* `Backbone.generate(request) -> MotionResult` — the actual generation.
+  May be `async def` or sync.
+* `Backbone.setup()` / `teardown()` — optional, for model loading and
+  GPU allocation.
+
+That's it.
+
+## Multi-model
+
+Serve more than one model from one process:
+
+```python
+serve({
+    "fast":    FastBackbone(),
+    "quality": QualityBackbone(),
+})
+```
+
+Or pass an iterable; ids come from each backbone's `capabilities().id`.
+
+## NullBackbone — try it now
+
+```bash
+pip install motionmcp-sdk
+python -m motionmcp.null_backbone
+# → MMCP server on :8000, returning rest pose for any request
+```
+
+## What's NOT in v0
+
+* **Async jobs** (`POST /generate` returning `202 Accepted`, `GET /generate/jobs/{id}`).
+  Sync only for now; planned for v0.2.
+* **Idempotency cache**. Spec-recommended but not required.
+* **Binary glTF** (`model/gltf-binary`). JSON only for now.
+* **fps resampling** between request fps and the model's native fps.
+  Backbones currently see `request.fps(spec.fps)` and are responsible
+  for honoring it.
+* **Built-in retargeting**. Set `supports_retargeting=False` and require
+  the canonical skeleton, or implement retargeting in your `generate()`.
+
+These are deliberate v0 omissions to keep the surface tight. Feedback
+welcome on which to prioritise next.
+
+## Status
+
+Alpha. The protocol is `v1.0-rc1`; the SDK API is `v0.1`. Expect minor
+shape changes before `v1.0`.
+
+## License
+
+Apache 2.0.

motionmcp_sdk-0.1.0/README.md

@@ -0,0 +1,137 @@
+# motionmcp
+
+Python SDK for **MMCP** — the [Motion Model Context Protocol][docs].
+
+Build a vendor-neutral motion-generation HTTP server in ~30 lines: the
+SDK handles wire-format validation, glTF encoding, and the standard
+error envelope; you implement model loading and a single `generate()`
+method.
+
+[docs]: https://animatica.ai/mmcp
+
+## Where this fits
+
+MMCP is a small HTTP protocol; this is the Python SDK that makes
+implementing the server side trivial.
+
+**Officially supported servers** (built on this SDK):
+- **[motionmcp-kimodo](https://github.com/animatica-ai/motionmcp-kimodo)** —
+  the Kimodo SOMA model. Open-source, self-hosted.
+- **MMCP Cloud** — hosted product. Adds skeleton retargeting, managed
+  GPUs, batch generation, multi-tenant auth.
+
+**Officially supported clients:**
+- **[Proscenium for Blender](https://github.com/animatica-ai/proscenium-blender)** —
+  directable motion generation in Blender 4.2+. Talks to any MMCP server.
+
+Want to add another model or DCC? The protocol is yours to implement —
+this SDK just makes the server side easy. See
+[Servers & clients](https://animatica.ai/mmcp/docs/get-started/implementations)
+for the full list and how to build your own.
+
+```python
+from motionmcp import Backbone, ModelSpec, GenerateRequest, MotionResult, serve
+
+class MyBackbone(Backbone):
+    def capabilities(self) -> ModelSpec:
+        return ModelSpec(
+            id="my-model",
+            fps=30.0,
+            canonical_skeleton=load_skeleton(),
+            supports_retargeting=False,
+            supported_constraints=["pose_keyframe"],
+        )
+
+    async def generate(self, req: GenerateRequest) -> MotionResult:
+        rotations    = self.model.run(req)        # (N, T, J, 4) (x,y,z,w)
+        translations = self.model.run_root(req)   # (N, T, 3)
+        return MotionResult(
+            rotations=rotations,
+            root_translations=translations,
+        )
+
+if __name__ == "__main__":
+    serve(MyBackbone())
+```
+
+That's the whole server. Hit `GET /capabilities` to discover the model;
+`POST /generate` to run it. Returns standard glTF 2.0 — load it with
+any glTF parser.
+
+## Install
+
+```bash
+pip install motionmcp-sdk
+```
+
+Requires Python 3.10+.
+
+## What the SDK gives you
+
+* **Schemas**: Pydantic models for the full wire format
+  (`Skeleton`, `Segment`, `Constraint`, `Options`, `GenerateRequest`).
+  Free validation, IDE autocomplete, OpenAPI docs at `/docs`.
+* **Endpoints**: `GET /capabilities`, `POST /generate`, plus a generic
+  exception → MMCP error envelope handler.
+* **Generic checks**: unknown model, unknown joint in constraint,
+  frame-out-of-range, retargeting policy, constraint count, prompt length,
+  duration limit. All raise the right `error.code`.
+* **glTF encoder**: numpy arrays in, glTF 2.0 JSON out, with the
+  `MMCP_motion` extension correctly populated.
+* **Reference impl**: `NullBackbone` returns a rest pose for any request.
+  Useful for plugin development against a real server with zero ML deps.
+
+## What you implement
+
+* `Backbone.capabilities() -> ModelSpec` — what model you serve.
+* `Backbone.generate(request) -> MotionResult` — the actual generation.
+  May be `async def` or sync.
+* `Backbone.setup()` / `teardown()` — optional, for model loading and
+  GPU allocation.
+
+That's it.
+
+## Multi-model
+
+Serve more than one model from one process:
+
+```python
+serve({
+    "fast":    FastBackbone(),
+    "quality": QualityBackbone(),
+})
+```
+
+Or pass an iterable; ids come from each backbone's `capabilities().id`.
+
+## NullBackbone — try it now
+
+```bash
+pip install motionmcp-sdk
+python -m motionmcp.null_backbone
+# → MMCP server on :8000, returning rest pose for any request
+```
+
+## What's NOT in v0
+
+* **Async jobs** (`POST /generate` returning `202 Accepted`, `GET /generate/jobs/{id}`).
+  Sync only for now; planned for v0.2.
+* **Idempotency cache**. Spec-recommended but not required.
+* **Binary glTF** (`model/gltf-binary`). JSON only for now.
+* **fps resampling** between request fps and the model's native fps.
+  Backbones currently see `request.fps(spec.fps)` and are responsible
+  for honoring it.
+* **Built-in retargeting**. Set `supports_retargeting=False` and require
+  the canonical skeleton, or implement retargeting in your `generate()`.
+
+These are deliberate v0 omissions to keep the surface tight. Feedback
+welcome on which to prioritise next.
+
+## Status
+
+Alpha. The protocol is `v1.0-rc1`; the SDK API is `v0.1`. Expect minor
+shape changes before `v1.0`.
+
+## License
+
+Apache 2.0.

motionmcp_sdk-0.1.0/docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

motionmcp_sdk-0.1.0/examples/quickstart.py

@@ -0,0 +1,62 @@
+"""Minimal motionmcp server — your model in ~30 lines.
+
+Run with:
+
+    python examples/quickstart.py
+
+Then in another shell:
+
+    curl -s http://localhost:8080/capabilities | jq
+    curl -s http://localhost:8080/generate -H 'Content-Type: application/json' \\
+         -d '{"protocol_version":"1.0","model":"my-model",
+              "skeleton":{"joints":[{"name":"Hips","parent":null,
+                                     "rest_translation":[0,0.95,0],
+                                     "rest_rotation":[0,0,0,1]}]},
+              "segments":[{"type":"text","prompt":"walk","duration_frames":30}]}'
+"""
+
+import numpy as np
+
+from motionmcp import (
+    Backbone,
+    GenerateRequest,
+    Joint,
+    ModelSpec,
+    MotionResult,
+    Skeleton,
+    serve,
+)
+
+
+class MyBackbone(Backbone):
+    def capabilities(self) -> ModelSpec:
+        return ModelSpec(
+            id="my-model",
+            fps=30.0,
+            canonical_skeleton=Skeleton(joints=[
+                Joint(name="Hips", parent=None,
+                      rest_translation=(0.0, 0.95, 0.0),
+                      rest_rotation=(0.0, 0.0, 0.0, 1.0)),
+            ]),
+            supports_retargeting=False,
+            supported_constraints=["pose_keyframe"],
+        )
+
+    async def generate(self, req: GenerateRequest) -> MotionResult:
+        # Replace this with: rotations, root_translations = self.model.run(req)
+        N = req.options.num_samples if req.options else 1
+        T = req.total_frames
+        J = len(req.skeleton.joints)
+
+        rotations = np.zeros((N, T, J, 4), dtype=np.float32)
+        rotations[..., 3] = 1.0
+        root_translations = np.zeros((N, T, 3), dtype=np.float32)
+
+        return MotionResult(
+            rotations=rotations,
+            root_translations=root_translations,
+        )
+
+
+if __name__ == "__main__":
+    serve(MyBackbone())