embodify-mcp 0.1.0a1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. embodify_mcp-0.1.0a1/.claude-plugin/marketplace.json +14 -0
  2. embodify_mcp-0.1.0a1/.gitattributes +7 -0
  3. embodify_mcp-0.1.0a1/.github/ISSUE_TEMPLATE/backend_request.yml +41 -0
  4. embodify_mcp-0.1.0a1/.github/ISSUE_TEMPLATE/bug_report.yml +55 -0
  5. embodify_mcp-0.1.0a1/.github/ISSUE_TEMPLATE/feature_request.yml +16 -0
  6. embodify_mcp-0.1.0a1/.github/pull_request_template.md +11 -0
  7. embodify_mcp-0.1.0a1/.github/workflows/ci.yml +40 -0
  8. embodify_mcp-0.1.0a1/.github/workflows/release.yml +39 -0
  9. embodify_mcp-0.1.0a1/.gitignore +24 -0
  10. embodify_mcp-0.1.0a1/CHANGELOG.md +36 -0
  11. embodify_mcp-0.1.0a1/CITATION.cff +23 -0
  12. embodify_mcp-0.1.0a1/CODE_OF_CONDUCT.md +132 -0
  13. embodify_mcp-0.1.0a1/CONTRIBUTING.md +52 -0
  14. embodify_mcp-0.1.0a1/LICENSE +202 -0
  15. embodify_mcp-0.1.0a1/MANIFEST.in +9 -0
  16. embodify_mcp-0.1.0a1/NOTICE +7 -0
  17. embodify_mcp-0.1.0a1/PKG-INFO +524 -0
  18. embodify_mcp-0.1.0a1/README.md +294 -0
  19. embodify_mcp-0.1.0a1/README.zh-CN.md +235 -0
  20. embodify_mcp-0.1.0a1/SECURITY.md +40 -0
  21. embodify_mcp-0.1.0a1/THIRD_PARTY_NOTICES.md +26 -0
  22. embodify_mcp-0.1.0a1/docs/action-contract.md +62 -0
  23. embodify_mcp-0.1.0a1/docs/agent-setup.md +166 -0
  24. embodify_mcp-0.1.0a1/docs/backend-development.md +46 -0
  25. embodify_mcp-0.1.0a1/docs/backends.md +171 -0
  26. embodify_mcp-0.1.0a1/docs/citation.md +27 -0
  27. embodify_mcp-0.1.0a1/embodify-skills/.claude-plugin/plugin.json +16 -0
  28. embodify_mcp-0.1.0a1/embodify-skills/skills/depth-ranging/SKILL.md +22 -0
  29. embodify_mcp-0.1.0a1/embodify-skills/skills/embodied-control/SKILL.md +51 -0
  30. embodify_mcp-0.1.0a1/embodify-skills/skills/object-segmentation/SKILL.md +20 -0
  31. embodify_mcp-0.1.0a1/embodify-skills/skills/robot-profile/SKILL.md +34 -0
  32. embodify_mcp-0.1.0a1/embodify-skills/skills/robot-profile/template.md +32 -0
  33. embodify_mcp-0.1.0a1/embodify-skills/skills/task-experience/SKILL.md +44 -0
  34. embodify_mcp-0.1.0a1/embodify_mcp/__init__.py +3 -0
  35. embodify_mcp-0.1.0a1/embodify_mcp/__main__.py +4 -0
  36. embodify_mcp-0.1.0a1/embodify_mcp/backend/__init__.py +0 -0
  37. embodify_mcp-0.1.0a1/embodify_mcp/backend/base.py +345 -0
  38. embodify_mcp-0.1.0a1/embodify_mcp/backend/catalogue.py +289 -0
  39. embodify_mcp-0.1.0a1/embodify_mcp/backend/coordinated.py +47 -0
  40. embodify_mcp-0.1.0a1/embodify_mcp/backend/fake.py +287 -0
  41. embodify_mcp-0.1.0a1/embodify_mcp/backend/libero.py +97 -0
  42. embodify_mcp-0.1.0a1/embodify_mcp/backend/remote.py +330 -0
  43. embodify_mcp-0.1.0a1/embodify_mcp/backend/robodojo.py +62 -0
  44. embodify_mcp-0.1.0a1/embodify_mcp/backend/serve.py +210 -0
  45. embodify_mcp-0.1.0a1/embodify_mcp/backend/stepped.py +409 -0
  46. embodify_mcp-0.1.0a1/embodify_mcp/backend/transport.py +189 -0
  47. embodify_mcp-0.1.0a1/embodify_mcp/backend/wire.py +150 -0
  48. embodify_mcp-0.1.0a1/embodify_mcp/errors.py +15 -0
  49. embodify_mcp-0.1.0a1/embodify_mcp/geometry.py +195 -0
  50. embodify_mcp-0.1.0a1/embodify_mcp/imaging.py +87 -0
  51. embodify_mcp-0.1.0a1/embodify_mcp/journal.py +102 -0
  52. embodify_mcp-0.1.0a1/embodify_mcp/mcp.py +1001 -0
  53. embodify_mcp-0.1.0a1/embodify_mcp/mcp_tools.py +270 -0
  54. embodify_mcp-0.1.0a1/embodify_mcp/monitor.py +303 -0
  55. embodify_mcp-0.1.0a1/embodify_mcp/monitor_page.html +1188 -0
  56. embodify_mcp-0.1.0a1/embodify_mcp/obs.py +26 -0
  57. embodify_mcp-0.1.0a1/embodify_mcp/primitives/__init__.py +0 -0
  58. embodify_mcp-0.1.0a1/embodify_mcp/primitives/controller.py +167 -0
  59. embodify_mcp-0.1.0a1/embodify_mcp/primitives/params.py +13 -0
  60. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/__init__.py +0 -0
  61. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/catalogue.py +96 -0
  62. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/config.py +62 -0
  63. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/coordinated.py +136 -0
  64. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/episode.py +167 -0
  65. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/isaac_driver.py +172 -0
  66. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/preflight.py +135 -0
  67. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/process.py +16 -0
  68. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/source.py +39 -0
  69. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/tasks.py +100 -0
  70. embodify_mcp-0.1.0a1/embodify_mcp/robodojo/worker.py +24 -0
  71. embodify_mcp-0.1.0a1/embodify_mcp/sim/__init__.py +0 -0
  72. embodify_mcp-0.1.0a1/embodify_mcp/sim/base.py +81 -0
  73. embodify_mcp-0.1.0a1/embodify_mcp/sim/fake.py +272 -0
  74. embodify_mcp-0.1.0a1/embodify_mcp/sim/libero_adapter.py +315 -0
  75. embodify_mcp-0.1.0a1/embodify_mcp/smoke.py +70 -0
  76. embodify_mcp-0.1.0a1/embodify_mcp/types.py +15 -0
  77. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/PKG-INFO +524 -0
  78. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/SOURCES.txt +106 -0
  79. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/dependency_links.txt +1 -0
  80. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/entry_points.txt +6 -0
  81. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/requires.txt +12 -0
  82. embodify_mcp-0.1.0a1/embodify_mcp.egg-info/top_level.txt +1 -0
  83. embodify_mcp-0.1.0a1/environments/libero-py38-constraints.txt +73 -0
  84. embodify_mcp-0.1.0a1/examples/mcp.json +11 -0
  85. embodify_mcp-0.1.0a1/examples/remote-ssh.json +19 -0
  86. embodify_mcp-0.1.0a1/examples/remote-stdio.json +12 -0
  87. embodify_mcp-0.1.0a1/examples/robodojo.json +12 -0
  88. embodify_mcp-0.1.0a1/pyproject.toml +44 -0
  89. embodify_mcp-0.1.0a1/setup.cfg +4 -0
  90. embodify_mcp-0.1.0a1/tests/__init__.py +0 -0
  91. embodify_mcp-0.1.0a1/tests/fixtures/robodojo_run_eval.py +100 -0
  92. embodify_mcp-0.1.0a1/tests/test_backend_contract.py +260 -0
  93. embodify_mcp-0.1.0a1/tests/test_coordinated_control.py +292 -0
  94. embodify_mcp-0.1.0a1/tests/test_extra_tools.py +75 -0
  95. embodify_mcp-0.1.0a1/tests/test_geometry.py +104 -0
  96. embodify_mcp-0.1.0a1/tests/test_gripper_settling.py +129 -0
  97. embodify_mcp-0.1.0a1/tests/test_mcp.py +986 -0
  98. embodify_mcp-0.1.0a1/tests/test_mcp_multi_arm.py +129 -0
  99. embodify_mcp-0.1.0a1/tests/test_monitor.py +124 -0
  100. embodify_mcp-0.1.0a1/tests/test_protocol_release.py +62 -0
  101. embodify_mcp-0.1.0a1/tests/test_remote_backend.py +364 -0
  102. embodify_mcp-0.1.0a1/tests/test_remote_latency.py +220 -0
  103. embodify_mcp-0.1.0a1/tests/test_remote_monitor.py +50 -0
  104. embodify_mcp-0.1.0a1/tests/test_robodojo_backend.py +252 -0
  105. embodify_mcp-0.1.0a1/tests/test_robodojo_budget.py +117 -0
  106. embodify_mcp-0.1.0a1/tests/test_robodojo_tasks.py +374 -0
  107. embodify_mcp-0.1.0a1/tools/check_release.py +73 -0
  108. embodify_mcp-0.1.0a1/tools/prepare_isaaclab_compat.py +44 -0
@@ -0,0 +1,14 @@
1
+ {
2
+ "name": "embodify",
3
+ "owner": {
4
+ "name": "Yida Yang"
5
+ },
6
+ "description": "Embodify: give your agent a body.",
7
+ "plugins": [
8
+ {
9
+ "name": "embodify-skills",
10
+ "source": "./embodify-skills",
11
+ "description": "Embodify skills: operate robots through the Embodify MCP server, keep a profile of the robot body and improve from experience."
12
+ }
13
+ ]
14
+ }
@@ -0,0 +1,7 @@
1
+ * text=auto
2
+ *.py text eol=lf
3
+ *.md text eol=lf
4
+ *.toml text eol=lf
5
+ *.json text eol=lf
6
+ *.yml text eol=lf
7
+ *.html text eol=lf
@@ -0,0 +1,41 @@
1
+ name: Backend request
2
+ description: Ask for support for a simulator, benchmark or robot.
3
+ labels: ["enhancement"]
4
+ body:
5
+ - type: markdown
6
+ attributes:
7
+ value: |
8
+ Tell us about the simulator, benchmark or robot you would like Embodify to support.
9
+ New backends are welcome as contributions too; see docs/backend-development.md.
10
+ - type: input
11
+ id: name
12
+ attributes:
13
+ label: Simulator, benchmark or robot
14
+ placeholder: e.g. RoboTwin, LeRobot SO-101
15
+ validations:
16
+ required: true
17
+ - type: input
18
+ id: link
19
+ attributes:
20
+ label: Link
21
+ description: Project page, repository or paper.
22
+ - type: textarea
23
+ id: embodiment
24
+ attributes:
25
+ label: Robot and sensors
26
+ description: Arms and grippers, mobile base, cameras and other sensors.
27
+ - type: textarea
28
+ id: interface
29
+ attributes:
30
+ label: Control interface
31
+ description: How it is controlled (Python API, ROS, vendor SDK), and its action and observation spaces if you know them.
32
+ - type: textarea
33
+ id: use
34
+ attributes:
35
+ label: What you would use it for
36
+ - type: checkboxes
37
+ id: contribute
38
+ attributes:
39
+ label: Contributing
40
+ options:
41
+ - label: I would like to help implement or test this backend.
@@ -0,0 +1,55 @@
1
+ name: Bug report
2
+ description: Something does not work as described.
3
+ labels: ["bug"]
4
+ body:
5
+ - type: markdown
6
+ attributes:
7
+ value: |
8
+ Thanks for the report. Leave out secrets, private host names and camera images you cannot share.
9
+ Report security vulnerabilities privately through the Security tab instead.
10
+ - type: textarea
11
+ id: what-happened
12
+ attributes:
13
+ label: What happened
14
+ description: What you did, what you expected and what happened instead.
15
+ validations:
16
+ required: true
17
+ - type: textarea
18
+ id: reproduce
19
+ attributes:
20
+ label: How to reproduce
21
+ description: Server command and options, and the tool calls involved if you have them.
22
+ - type: input
23
+ id: version
24
+ attributes:
25
+ label: Embodify version
26
+ description: The output of `embodify-mcp --version`.
27
+ validations:
28
+ required: true
29
+ - type: dropdown
30
+ id: backend
31
+ attributes:
32
+ label: Backend
33
+ options:
34
+ - fake or fake-two-arm
35
+ - libero
36
+ - robodojo
37
+ - remote
38
+ - other
39
+ validations:
40
+ required: true
41
+ - type: input
42
+ id: agent
43
+ attributes:
44
+ label: Agent host and model
45
+ placeholder: e.g. Claude Code with Claude Opus 5.5
46
+ - type: input
47
+ id: system
48
+ attributes:
49
+ label: Operating system and Python version
50
+ - type: textarea
51
+ id: logs
52
+ attributes:
53
+ label: Logs
54
+ description: Server stderr, error messages or the relevant lines of events.jsonl.
55
+ render: text
@@ -0,0 +1,16 @@
1
+ name: Feature or skill request
2
+ description: Suggest a tool, a skill or another improvement.
3
+ labels: ["enhancement"]
4
+ body:
5
+ - type: textarea
6
+ id: idea
7
+ attributes:
8
+ label: What you would like
9
+ description: The tool, skill or change, and the problem it solves.
10
+ validations:
11
+ required: true
12
+ - type: textarea
13
+ id: context
14
+ attributes:
15
+ label: Context
16
+ description: The backend, agent and task where you need it, and any related work or papers.
@@ -0,0 +1,11 @@
1
+ ## What this changes
2
+
3
+ <!-- What changed and why. Link related issues. -->
4
+
5
+ ## Checks
6
+
7
+ - [ ] `python -m pytest -q` passes
8
+ - [ ] `python tools/check_release.py` passes
9
+ - [ ] Backend changes are tested on that backend, not only on Fake
10
+ - [ ] Docs, both READMEs and the changelog are updated where needed
11
+ - [ ] No credentials, personal host configuration, run logs or simulator assets
@@ -0,0 +1,40 @@
1
+ name: core
2
+ on: [push, pull_request]
3
+ permissions:
4
+ contents: read
5
+ jobs:
6
+ test:
7
+ strategy:
8
+ fail-fast: false
9
+ matrix:
10
+ os: [ubuntu-latest, windows-latest]
11
+ python: ['3.10', '3.12']
12
+ include:
13
+ - os: ubuntu-22.04
14
+ python: '3.8'
15
+ runs-on: ${{ matrix.os }}
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+ - uses: actions/setup-python@v5
19
+ with:
20
+ python-version: ${{ matrix.python }}
21
+ - run: python -m pip install -e ".[dev,media,diagnostics]"
22
+ - run: python -m pytest -q
23
+ - run: python tools/check_release.py
24
+ - run: python -m build
25
+ - run: python -m twine check dist/*
26
+ installed-wheel:
27
+ runs-on: ubuntu-latest
28
+ steps:
29
+ - uses: actions/checkout@v4
30
+ - uses: actions/setup-python@v5
31
+ with:
32
+ python-version: '3.12'
33
+ - run: python -m pip install build
34
+ - run: python -m build
35
+ - run: python -m venv "$RUNNER_TEMP/embodify-verify"
36
+ - run: '"$RUNNER_TEMP/embodify-verify/bin/python" -m pip install dist/*.whl'
37
+ - working-directory: ${{ runner.temp }}
38
+ run: |
39
+ "$RUNNER_TEMP/embodify-verify/bin/embodify-mcp-smoke"
40
+ "$RUNNER_TEMP/embodify-verify/bin/embodify-mcp-smoke" --remote
@@ -0,0 +1,39 @@
1
+ name: release
2
+ on:
3
+ release:
4
+ types: [published]
5
+ permissions:
6
+ contents: read
7
+ jobs:
8
+ build:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+ - uses: actions/setup-python@v5
13
+ with:
14
+ python-version: '3.12'
15
+ - name: Tag matches package version
16
+ run: |
17
+ version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
18
+ test "${GITHUB_REF_NAME}" = "v${version}" || { echo "tag ${GITHUB_REF_NAME} does not match version ${version}"; exit 1; }
19
+ - run: python -m pip install build twine
20
+ - run: python -m build
21
+ - run: python -m twine check dist/*
22
+ - uses: actions/upload-artifact@v4
23
+ with:
24
+ name: dist
25
+ path: dist/
26
+ pypi:
27
+ needs: build
28
+ runs-on: ubuntu-latest
29
+ environment:
30
+ name: pypi
31
+ url: https://pypi.org/project/embodify-mcp/
32
+ permissions:
33
+ id-token: write
34
+ steps:
35
+ - uses: actions/download-artifact@v4
36
+ with:
37
+ name: dist
38
+ path: dist/
39
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,24 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ .pytest_cache/
4
+ .venv*/
5
+ *.egg-info/
6
+ build/
7
+ dist/
8
+ out/
9
+ .env
10
+ .env.*
11
+ !.env.example
12
+ *.local.json
13
+ *.local.toml
14
+ .codex/
15
+ .claude/
16
+ .mcp.json
17
+ *.pem
18
+ *.key
19
+ *.safetensors
20
+ *.ckpt
21
+ *.pt
22
+ *.pth
23
+ *.hdf5
24
+ *.h5
@@ -0,0 +1,36 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0a1 — First release
4
+
5
+ Embodify gives your agent a body: an MCP server and a set of skills that let
6
+ Codex, Claude Code and other agents control robots.
7
+
8
+ **MCP server (`embodify-mcp`)**
9
+
10
+ - Tools: `get_session_info`, `list_tasks`, `reset_task`, `observe`,
11
+ `move_relative`, `set_gripper`, `stop_episode`, and `control_arms` for
12
+ coordinated two-arm motion.
13
+ - Backends: one- and two-arm Fake, LIBERO with all 130 tasks, and RoboDojo with
14
+ dual ARX X5 arms on all 54 simulation tasks, chosen by the agent or fixed by
15
+ the operator, each with its native episode limit unless overridden.
16
+ - Remote backends over SSH or TCP, with heartbeats for slow links and
17
+ reconnection through `reset_task`.
18
+ - Live monitor and replay: watch running episodes in a browser, or replay past
19
+ runs frame by frame, in English or Chinese.
20
+ - MCP over stdio, protocol versions 2024-11-05 to 2025-11-25.
21
+ - Commands: `embodify-mcp`, `embodify-mcp-backend`, `embodify-mcp-monitor`,
22
+ `embodify-mcp-preflight` and `embodify-mcp-smoke`.
23
+
24
+ **Skills pack (`embodify-skills`)**
25
+
26
+ - `embodied-control`, `robot-profile` and `task-experience`.
27
+ - Coming soon: `object-segmentation` and `depth-ranging`.
28
+
29
+ **Installation**
30
+
31
+ - Plugin marketplace in `.claude-plugin/` for Claude Code and Codex: install the
32
+ skills with `claude plugin install embodify-skills@embodify` or
33
+ `codex plugin add embodify-skills@embodify`, and register the MCP server as
34
+ `embodify`.
35
+ - One-line setup: agents install Embodify for themselves by following
36
+ `docs/agent-setup.md`.
@@ -0,0 +1,23 @@
1
+ cff-version: 1.2.0
2
+ message: "If Embodify helps your research, please cite it as below."
3
+ title: "Embodify: Give Your Agent a Body"
4
+ type: software
5
+ authors:
6
+ - family-names: Yang
7
+ given-names: Yida
8
+ version: 0.1.0a1
9
+ date-released: 2026-10-02
10
+ license: Apache-2.0
11
+ repository-code: "https://github.com/YidaYang/embodify"
12
+ url: "https://github.com/YidaYang/embodify"
13
+ abstract: >-
14
+ Embodify lets the agent you already use, such as Claude Code or Codex, observe and
15
+ control robots through an MCP server and a pack of agent skills, with simulator
16
+ backends for LIBERO and RoboDojo.
17
+ keywords:
18
+ - embodied AI
19
+ - robotics
20
+ - robot manipulation
21
+ - MCP
22
+ - LLM agents
23
+ - agent evaluation
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported privately to the project maintainer, Yida Yang, using the contact
63
+ details on the maintainer's GitHub profile.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,52 @@
1
+ # Contributing to Embodify
2
+
3
+ Contributions are welcome: new simulators and robots, new skills, fixes and
4
+ documentation. By taking part you agree to follow the
5
+ [code of conduct](CODE_OF_CONDUCT.md).
6
+
7
+ ## Set up
8
+
9
+ ```sh
10
+ python -m pip install -e ".[dev]"
11
+ python -m pytest -q
12
+ python tools/check_release.py
13
+ ```
14
+
15
+ Core tests run without a GPU, simulator downloads, credentials or network
16
+ access. To check an installed package, run `embodify-mcp-smoke` from outside
17
+ the checkout.
18
+
19
+ ## Adding a backend
20
+
21
+ To request support for a simulator or robot, open an issue with the backend
22
+ request form. To add one yourself, follow [writing a backend](docs/backend-development.md).
23
+ Add the backend to the contract test suite, document its setup in
24
+ [backend setup](docs/backends.md) and add it to the backend table in both
25
+ READMEs. Test changes to a simulator or robot backend on that backend, not only
26
+ on Fake.
27
+
28
+ ## Adding a skill
29
+
30
+ Create `embodify-skills/skills/<skill-name>/SKILL.md` with `name` and
31
+ `description` in its frontmatter, and keep supporting files such as templates
32
+ in the same folder. Write for the agent: concrete steps, what to check after
33
+ each action and what to avoid. If you use Claude Code, check the skills pack
34
+ with `claude plugin validate --strict embodify-skills/.claude-plugin/plugin.json`.
35
+ List the new skill in both READMEs.
36
+
37
+ ## Changing action semantics
38
+
39
+ Changes to motion, grippers or stop reasons need contract tests. Validate the
40
+ whole input before moving any arm, never replay a timed-out movement
41
+ automatically, and document units, frames and stop reasons in the
42
+ [action contract](docs/action-contract.md).
43
+
44
+ ## Pull requests
45
+
46
+ - Keep simulator and GPU imports lazy, so importing the core never loads them.
47
+ - Put backend-specific dependencies in that backend's setup instructions, not in
48
+ the core package dependencies.
49
+ - Do not commit credentials, personal host configuration, run logs or simulator assets.
50
+ - Preserve third-party notices.
51
+
52
+ Contributions are licensed under Apache-2.0 unless a file states otherwise.