agent-plugins 0.0.1__tar.gz → 0.1.1__tar.gz

agent_plugins-0.1.1/.agent-plugin/plugin.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
+  "name": "agent-plugins",
+  "description": "Ship Agent Plugins with Python packages and inspect their installed files.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Péter Ferenc Gyarmati",
+    "email": "dev.petergy@gmail.com"
+  },
+  "repository": "https://github.com/peter-gy/agent-plugins",
+  "keywords": ["python", "agent-plugins", "agent-skills"]
+}

agent_plugins-0.1.1/.agent-plugin/skills/agent-plugins/SKILL.md

@@ -0,0 +1,195 @@
+---
+name: agent-plugins
+description: Ship Agent Skills, MCP server configuration, and extension files with a Python package, choosing build-time or runtime access as needed. Use when adding an Agent Plugin to a Python project, configuring uv_build or Hatchling, locating installed plugin and skill paths, traversing skill files, reading manifest, skill source, or MCP values, or verifying wheel, source distribution, and editable installs.
+---
+
+# Agent Plugins
+
+Use `agent-plugins` when a Python package should carry the instructions and MCP
+configuration that match its installed code version.
+
+An [Agent Plugin](https://agent-plugins.org/) is an open, vendor-neutral
+portable directory format for reusable agent components. Its fixed locations
+let compatible clients find [Agent Skills](https://agentskills.io/specification)
+and [Model Context Protocol (MCP)](https://modelcontextprotocol.io/specification)
+server configuration in the same package. Distribution, permissions, and user
+experience remain with each client.
+
+## Build the plugin tree
+
+Keep one Agent Plugin tree in the codebase:
+
+```text
+my-plugin/
+├── plugin.json
+├── skills/
+│   └── use-my-package/
+│       ├── SKILL.md
+│       ├── scripts/
+│       └── references/
+├── mcp.json
+└── com.example.client/
+    └── hooks/
+```
+
+- `plugin.json` identifies the plugin and its Agent Plugins schema.
+- `skills/` contains Agent Skills and their nested files.
+- `mcp.json` describes stdio, Streamable HTTP, or legacy HTTP+SSE servers.
+- Reverse-domain directories contain client-specific extension files.
+
+Create a minimal `plugin.json` at the plugin root:
+
+```json
+{
+  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
+  "name": "my-project"
+}
+```
+
+Find the Python package's `pyproject.toml` and set
+`[tool.agent-plugins].root` relative to that file. For uv_build:
+
+```toml
+[build-system]
+requires = ["agent-plugins==0.1.1", "uv_build==0.12.2"]
+build-backend = "agent_plugins.build.uv_build"
+
+[tool.agent-plugins]
+root = "../.."
+```
+
+For Hatchling:
+
+```toml
+[build-system]
+requires = ["agent-plugins==0.1.1", "hatchling==1.31.0"]
+build-backend = "agent_plugins.build.hatchling"
+
+[tool.agent-plugins]
+root = "../.."
+```
+
+The build selects `plugin.json`, the complete `skills/` tree, and `mcp.json`
+when present. Select other root-relative files explicitly:
+
+```toml
+[tool.agent-plugins]
+root = "../.."
+include = ["bin/**", "com.example.client/**"]
+```
+
+Every include pattern must stay within the plugin root and match at least one
+file.
+
+Use the build plan directly when another build system owns artifact writing:
+
+```python
+import agent_plugins as ap
+
+plan = ap.build_plan("packages/python")
+for file in plan.files:
+    print(file.source, file.target)
+```
+
+`agent_plugins.build.BuildBackend` provides the wheel, source distribution, and
+editable hooks used by the bundled adapters.
+
+## Choose build-time or runtime access
+
+Keeping `agent-plugins` in `[build-system].requires` makes it available during
+the build. Add the package to `[project].dependencies` when installed Python
+code needs to locate or inspect Agent Plugins:
+
+```toml
+[project]
+dependencies = ["agent-plugins==0.1.1"]
+```
+
+Locate a plugin with the Python package name used by pip:
+
+```python
+import agent_plugins as ap
+
+plugin = ap.locate("my-package")
+
+print(plugin.path)
+print(plugin.manifest.path)
+print(plugin.manifest.name)
+
+for skill in plugin.skills:
+    print(skill.path)
+    print(skill / "SKILL.md")
+
+if mcp := plugin.mcp:
+    for name, server in mcp.servers.items():
+        print(name, server)
+```
+
+`plugin.path` is the absolute installed plugin root. Each item in
+`plugin.skills` is an `ap.Skill` rooted at one immediate directory under
+`skills/`. Use `Path(skill)` or `skill.path` for that directory. Use `/` to
+build native paths to its instructions, references, scripts, or assets:
+
+```python
+skill = plugin.skills[0]
+
+print(skill / "SKILL.md")
+print(skill / "references" / "api.md")
+print(skill.tree(max_depth=2))
+```
+
+Use `skill.frontmatter` for the source text between the `---` delimiters. Use
+`skill.body` for the Markdown source after the frontmatter. The first access to
+either property reads and splits `SKILL.md`, then caches both strings. Path and
+tree access leave the document unread so an agent can choose which files and
+content to load.
+
+`plugin.manifest` is an `ap.Manifest`. `plugin.mcp` is an `ap.MCPConfig` when
+`mcp.json` exists. Each object exposes `.path` immediately. Accessing a parsed
+field such as `manifest.name` or `mcp.servers` reads, validates, and caches its
+document. MCP access validates the manifest first.
+
+MCP servers are frozen `ap.StdioServer`, `ap.StreamableHTTPServer`, or
+`ap.SSEServer` values in a read-only mapping. `manifest.issues` records ignored
+manifest fields. `mcp.issues` records invalid server entries skipped during
+loading. Document-level failures raise `ap.ValidationError` on parsed value
+access.
+
+Display the plugin to inspect its packaged tree:
+
+```python
+print(plugin)
+print(plugin.tree(max_depth=2))
+print(plugin.tree(max_depth=None, max_files=None))
+```
+
+`Path(plugin)`, `Path(skill)`, and `Path(plugin.manifest)` use the native path
+protocol. When `plugin.mcp` is present, `Path(plugin.mcp)` does too.
+`ap.installed()` returns each discovered plugin keyed by installed Python
+package name.
+
+## Verify the package
+
+Inspect the selected paths before building:
+
+```console
+agent-plugins plan path/to/python-project
+```
+
+Then verify the package through its installation boundaries:
+
+1. Build a wheel and source distribution.
+2. Build a wheel from the source distribution.
+3. Install the wheel in a clean environment.
+4. Install the Python package as editable.
+5. Call `ap.locate()` in both environments.
+6. Access `plugin.manifest.name` and `plugin.mcp.servers` when MCP exists to run
+   schema validation and the Agent Plugins rules.
+7. Confirm each `skill.path`, `skill / "SKILL.md"`, and `skill.files` points to
+   the packaged skill tree.
+8. Access `skill.frontmatter` and `skill.body` to verify the packaged
+   `SKILL.md` structure.
+
+Handle `ap.AgentPluginError` when a requested Python package or usable plugin
+root is absent. Handle `ap.ValidationError` when an installed plugin document
+or `SKILL.md` structure is invalid.

agent_plugins-0.1.1/.agent-plugin/skills/agent-plugins/agents/openai.yaml

@@ -0,0 +1,4 @@
+interface:
+  display_name: "Agent Plugins"
+  short_description: "Ship agent components with Python packages"
+  default_prompt: "Use $agent-plugins to ship agent skills and MCP configuration with this Python package."

agent_plugins-0.1.1/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Péter Ferenc Gyarmati
+
+                                 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.

agent_plugins-0.1.1/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: agent-plugins
+Version: 0.1.1
+Summary: Ship Agent Plugins with Python packages and inspect their installed files
+Author: Péter Ferenc Gyarmati
+Author-email: Péter Ferenc Gyarmati <dev.petergy@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3.10
+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: Typing :: Typed
+Requires-Dist: tomli==2.3.1 ; python_full_version < '3.11'
+Requires-Python: >=3.10, <3.15
+Project-URL: Source, https://github.com/peter-gy/agent-plugins
+Description-Content-Type: text/markdown
+
+# agent-plugins
+
+`agent-plugins` packages Agent Skills, Model Context Protocol configuration, and
+client extension files with a Python distribution. Each installed wheel carries
+the agent files that match its code version.
+
+The package implements the portable [Agent Plugins](https://agent-plugins.org/)
+directory format and supports Python 3.10 through 3.14.
+
+## Ship an Agent Plugin
+
+Keep one Agent Plugin tree beside the code it documents:
+
+```text
+my-project/
+├── plugin.json
+├── skills/
+│   └── use-my-package/
+│       ├── SKILL.md
+│       ├── agents/
+│       ├── references/
+│       └── scripts/
+├── mcp.json
+└── packages/
+    └── python/
+        └── pyproject.toml
+```
+
+`skills/` contains [Agent Skills](https://agentskills.io/specification).
+`mcp.json` contains [Model Context Protocol](https://modelcontextprotocol.io/specification)
+server configuration when the plugin provides MCP servers.
+
+Create `plugin.json` at the plugin root:
+
+```json
+{
+  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
+  "name": "my-project"
+}
+```
+
+Configure the Python package to wrap `uv_build`:
+
+```toml
+[build-system]
+requires = ["agent-plugins==0.1.1", "uv_build==0.12.2"]
+build-backend = "agent_plugins.build.uv_build"
+
+[tool.agent-plugins]
+root = "../.."
+```
+
+`root` is relative to `pyproject.toml`. The build selects `plugin.json`, the
+complete `skills/` tree, and `mcp.json` when present.
+
+Build, install, and locate the packaged plugin:
+
+```console
+uv build packages/python --out-dir dist
+python -m pip install "agent-plugins==0.1.1" dist/my_package-*.whl
+agent-plugins locate my-package
+```
+
+```text
+/.../site-packages/my_package-1.2.3.agent-plugin
+```
+
+The wheel contains the plugin directory and an `agent_plugins.json` marker in
+the distribution metadata. A source distribution stages the same files for a
+reproducible wheel rebuild. An editable install points the marker at the authored
+plugin tree.
+
+### Use Hatchling
+
+Keep the plugin settings and select the Hatchling adapter:
+
+```toml
+[build-system]
+requires = ["agent-plugins==0.1.1", "hatchling==1.31.0"]
+build-backend = "agent_plugins.build.hatchling"
+
+[tool.agent-plugins]
+root = "../.."
+```
+
+### Include other plugin files
+
+Add root-relative patterns for executables or client extensions:
+
+```toml
+[tool.agent-plugins]
+root = "../.."
+include = ["bin/**", "com.example.client/**"]
+```
+
+Each pattern must stay within the plugin root and match at least one file.
+
+## Inspect an installed plugin
+
+Add `agent-plugins` to the runtime dependencies of Python code that calls the
+inspection API:
+
+```toml
+[project]
+dependencies = ["agent-plugins==0.1.1"]
+```
+
+```python
+import agent_plugins as ap
+
+plugin = ap.locate("my-package")
+
+print(plugin.manifest.name)
+print(plugin.manifest.path)
+
+for skill in plugin.skills:
+    print(skill.path)
+    print(skill / "SKILL.md")
+
+if mcp := plugin.mcp:
+    for name, server in mcp.servers.items():
+        print(name, server)
+```
+
+`ap.locate()` accepts the distribution name used by `pip`. `ap.installed()`
+returns every discovered Agent Plugin keyed by distribution name.
+
+| Object | Access |
+| --- | --- |
+| `plugin.path` | Absolute plugin root |
+| `plugin.manifest` | Lazy `plugin.json` document |
+| `plugin.skills` | `ap.Skill` objects rooted under `skills/` |
+| `plugin.mcp` | Lazy `mcp.json` document, when present |
+| `plugin.files` | Files selected by the package build |
+| `plugin.tree()` | Bounded ASCII tree of the installed plugin |
+| `skill.frontmatter` | Source text between the `---` delimiters |
+| `skill.body` | Markdown after the frontmatter |
+| `skill.files` | Files selected below the skill root |
+
+Manifest, MCP, and skill documents load on first parsed-field access and cache
+their result. Call `ap.locate()` again to read a fresh snapshot. Invalid
+documents raise `ap.ValidationError`.
+
+MCP servers are frozen `ap.StdioServer`, `ap.StreamableHTTPServer`, or
+`ap.SSEServer` values. Their fields preserve placeholders such as
+`${PLUGIN_ROOT}` for the agent client to resolve.
+
+## Inspect a build plan
+
+Preview the files selected by `[tool.agent-plugins]` before building:
+
+```console
+agent-plugins plan packages/python
+```
+
+Use `--json` for machine-readable output. Python build integrations can consume
+the same plan:
+
+```python
+import agent_plugins as ap
+
+plan = ap.build_plan("packages/python")
+for file in plan.files:
+    print(file.source, "->", file.target)
+```
+
+List every plugin visible in the current environment:
+
+```console
+agent-plugins list --json
+```
+
+## Develop and release
+
+From a repository checkout, install the locked development environment and run
+the local checks:
+
+```console
+uv sync --locked
+uv run ruff format --check src tests
+uv run ruff check src tests
+uv run ty check
+uv run pyrefly check
+uv run pytest -q
+./scripts/build-dist.sh
+```
+
+Prepare the version and lockfile in a release pull request:
+
+```console
+uv version --bump patch
+```
+
+After the release commit reaches `main` and its push CI passes, update the local
+branch and start the tag-driven release:
+
+```console
+git pull --ff-only origin main
+./scripts/release.sh --dry-run
+./scripts/release.sh
+```
+
+Before the first tag, configure PyPI to trust `.github/workflows/publish.yml`
+through the repository's `pypi` environment. PyPI documents the setup in
+[Adding a Trusted Publisher](https://docs.pypi.org/trusted-publishers/adding-a-publisher/).