agentskills-agentframework 0.1.0__py3-none-any.whl

agentskills_agentframework/__init__.py

@@ -0,0 +1,22 @@
+"""Microsoft Agent Framework integration for Agent Skills.
+
+This package bridges :mod:`agentskills_core` and `Microsoft Agent Framework
+<https://github.com/microsoft/agent-framework>`_, providing:
+
+* :func:`get_tools` -- generates five
+  :class:`~agent_framework.FunctionTool` instances that let an
+  AI agent consume skills.
+* :func:`get_tools_usage_instructions` -- returns agent-facing
+  instructions explaining how to use the tools.
+
+Install::
+
+    pip install agentskills-agentframework
+"""
+
+from agentskills_agentframework.tools import get_tools, get_tools_usage_instructions
+
+__all__ = [
+    "get_tools",
+    "get_tools_usage_instructions",
+]

agentskills_agentframework/tools.py

@@ -0,0 +1,187 @@
+"""Microsoft Agent Framework integration for Agent Skills.
+
+This module converts a :class:`~agentskills_core.SkillRegistry` into a
+set of :class:`~agent_framework.FunctionTool` instances that an AI
+agent can invoke to read skill metadata and instructions, and retrieve
+bundled resources.
+
+Skill *discovery* is handled separately: the application injects the
+skill catalog (via :meth:`SkillRegistry.get_skills_catalog`) into the
+system prompt so the agent already knows which skills are available.
+The tools here cover **activation and resource retrieval** only.
+
+==============================  =============================================
+Tool name                       Description
+==============================  =============================================
+``get_skill_metadata``          Read frontmatter (name, description, ...).
+``get_skill_body``              Load full skill instructions.
+``get_skill_reference``         Read a single reference document.
+``get_skill_script``            Read a single script.
+``get_skill_asset``             Read a single asset.
+==============================  =============================================
+
+All tools are ``async`` to match the underlying async provider interface.
+
+Example::
+
+    from agentskills_agentframework import get_tools
+
+    tools = get_tools(registry)
+    # Pass *tools* to a Microsoft Agent Framework agent.
+"""
+
+from __future__ import annotations
+
+import json
+
+from agent_framework import FunctionTool, tool
+
+from agentskills_core import SkillRegistry
+
+
+def get_tools(registry: SkillRegistry) -> list[FunctionTool]:
+    """Build Agent Framework tools that expose an Agent Skills registry.
+
+    Each tool wraps a :class:`~agentskills_core.SkillRegistry` or
+    :class:`~agentskills_core.Skill` method, serialising the result
+    as JSON (for dicts) or plain text (for content bodies).
+    Tools are **read-only** -- they retrieve content but never execute
+    scripts or modify state.
+
+    Skill discovery is handled via the catalog in the system prompt,
+    so no ``list_skills`` tool is included.
+
+    All tools are async coroutines.
+
+    Args:
+        registry: The :class:`~agentskills_core.SkillRegistry` whose
+            skills should be exposed as tools.
+
+    Returns:
+        A list of :class:`~agent_framework.FunctionTool`
+        instances ready to be passed to an Agent Framework agent.
+    """
+
+    @tool(
+        name="get_skill_metadata",
+        description=(
+            "Get structured metadata (name, description, and optional "
+            "fields like license, compatibility, metadata) for a specific skill."
+        ),
+    )
+    async def get_skill_metadata(skill_id: str) -> str:
+        """Get structured metadata for a skill."""
+        skill = registry.get_skill(skill_id)
+        return json.dumps(await skill.get_metadata())
+
+    @tool(
+        name="get_skill_body",
+        description=(
+            "Get the full instructions and guidance (markdown body) for a specific skill."
+        ),
+    )
+    async def get_skill_body(skill_id: str) -> str:
+        """Get the full instructions / markdown body for a skill."""
+        skill = registry.get_skill(skill_id)
+        return await skill.get_body()
+
+    @tool(
+        name="get_skill_reference",
+        description=(
+            "Get the full content of a specific reference document "
+            "from a skill. Provide both skill_id and the reference name."
+        ),
+    )
+    async def get_skill_reference(skill_id: str, name: str) -> str:
+        """Get the content of a specific reference document."""
+        skill = registry.get_skill(skill_id)
+        return (await skill.get_reference(name)).decode("utf-8", errors="replace")
+
+    @tool(
+        name="get_skill_asset",
+        description=(
+            "Get the content of a specific asset from a skill. "
+            "Provide both skill_id and the asset name."
+        ),
+    )
+    async def get_skill_asset(skill_id: str, name: str) -> str:
+        """Get the content of a specific asset."""
+        skill = registry.get_skill(skill_id)
+        return (await skill.get_asset(name)).decode("utf-8", errors="replace")
+
+    @tool(
+        name="get_skill_script",
+        description=(
+            "Get the content of a specific script from a skill. "
+            "Provide both skill_id and the script name."
+        ),
+    )
+    async def get_skill_script(skill_id: str, name: str) -> str:
+        """Get the content of a specific script."""
+        skill = registry.get_skill(skill_id)
+        return (await skill.get_script(name)).decode("utf-8", errors="replace")
+
+    return [
+        get_skill_metadata,
+        get_skill_body,
+        get_skill_reference,
+        get_skill_asset,
+        get_skill_script,
+    ]
+
+
+def get_tools_usage_instructions() -> str:
+    """Return agent instructions for using the Agent Skills tools.
+
+    This text explains to an AI agent **how** to use the skill
+    tools (``get_skill_metadata``, ``get_skill_body``,
+    ``get_skill_reference``, ``get_skill_script``, ``get_skill_asset``)
+    following the progressive-disclosure workflow.
+
+    Combine with the skill catalog produced by
+    :meth:`SkillRegistry.get_skills_catalog` to give the agent both
+    *what* skills are available and *how* to interact with them::
+
+        catalog = await registry.get_skills_catalog(format="xml")
+        instructions = get_tools_usage_instructions()
+        system_prompt = f"{catalog}\\n\\n{instructions}"
+
+    Returns:
+        A multi-line instruction string ready for system-prompt
+        insertion.
+    """
+    return _TOOLS_USAGE_INSTRUCTIONS
+
+
+_TOOLS_USAGE_INSTRUCTIONS = """\
+## How to Use Agent Skills
+
+You have access to a set of **Agent Skills** — curated knowledge \
+bundles that contain step-by-step instructions, reference documents, \
+scripts, and assets. The available skills are listed above.
+
+### Workflow
+
+1. **Pick a skill** — Choose the most relevant skill from the catalog \
+above based on the user's request.
+2. **Read metadata** — Call `get_skill_metadata(skill_id)` to get \
+structured information (name, description, and optional fields).
+3. **Read the body** — Call `get_skill_body(skill_id)` to load the \
+full instructions. Follow these instructions carefully.
+4. **Fetch resources on demand** — The skill body will reference \
+specific resources by name. Use the appropriate tool to retrieve them:
+   - `get_skill_reference(skill_id, name)` — reference documents \
+(policies, templates, runbooks)
+   - `get_skill_script(skill_id, name)` — executable scripts
+   - `get_skill_asset(skill_id, name)` — diagrams, data files, or \
+other assets
+
+### Important guidelines
+
+- **Do not guess resource names.** Only fetch resources that are \
+explicitly mentioned in the skill body.
+- **Follow progressive disclosure.** Read the skill body first, then \
+fetch only the resources you need for the current step.
+- **One skill at a time.** Focus on the most relevant skill for the \
+user's request. If multiple skills apply, address them sequentially.\
+"""

agentskills_agentframework-0.1.0.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: agentskills-agentframework
+Version: 0.1.0
+Summary: Microsoft Agent Framework integration for the Agent Skills format (https://agentskills.io)
+License: MIT
+Author: Pratik Panda
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: agent-framework (>=1.0.0b1)
+Requires-Dist: agentskills-core (>=0.1.0)
+Project-URL: Homepage, https://agentskills.io
+Project-URL: Repository, https://github.com/pratikxpanda/agentskills-sdk
+Description-Content-Type: text/markdown
+
+# agentskills-agentframework
+
+> Microsoft Agent Framework integration for the [Agent Skills SDK](../../../README.md) — turn a skill registry into Agent Framework tools.
+
+Generates a set of [Microsoft Agent Framework](https://pypi.org/project/agent-framework/) `FunctionTool` instances from a `SkillRegistry`, ready to be passed to any Agent Framework agent.
+
+## Installation
+
+```bash
+pip install agentskills-agentframework
+```
+
+Requires Python 3.12+. Installs `agentskills-core` and `agent-framework` as dependencies.
+
+## Usage
+
+```python
+from agentskills_core import SkillRegistry
+from agentskills_fs import LocalFileSystemSkillProvider
+from agentskills_agentframework import get_tools, get_tools_usage_instructions
+
+# Set up registry
+provider = LocalFileSystemSkillProvider(Path("./skills"))
+registry = SkillRegistry()
+await registry.register("incident-response", provider)
+
+# Build tools + system prompt
+tools = get_tools(registry)
+catalog = await registry.get_skills_catalog(format="xml")
+instructions = get_tools_usage_instructions()
+system_prompt = f"{catalog}\n\n{instructions}"
+```
+
+Pass `tools` to your Agent Framework agent and inject `system_prompt` into the `instructions`. The catalog tells the agent *what* skills exist; the usage instructions tell it *how* to use the tools.
+
+## Generated Tools
+
+| Tool | Parameters | Description |
+| --- | --- | --- |
+| `get_skill_metadata` | `skill_id` | Get structured metadata (name, description, etc.) |
+| `get_skill_body` | `skill_id` | Load the full markdown instructions |
+| `get_skill_reference` | `skill_id`, `name` | Read a reference document |
+| `get_skill_script` | `skill_id`, `name` | Read a script |
+| `get_skill_asset` | `skill_id`, `name` | Read an asset |
+
+All tools are async-compatible (`FunctionTool` with `@tool` decorator).
+
+## API
+
+### `get_tools(registry: SkillRegistry) -> list[FunctionTool]`
+
+Returns a list of Agent Framework function tools bound to the given registry.
+
+### `get_tools_usage_instructions() -> str`
+
+Returns a markdown string explaining the progressive-disclosure workflow — read metadata, then body, then fetch resources on demand. Designed for system-prompt injection alongside the skill catalog.
+
+## Example
+
+See [examples/agent-framework/](../../../examples/agent-framework/) for full working demos.
+
+## License
+
+MIT
+

agentskills_agentframework-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+agentskills_agentframework/__init__.py,sha256=lF8beb8XKG-OvYkGBRglXYu2KqDKyhN395pyXgF-A0E,672
+agentskills_agentframework/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+agentskills_agentframework/tools.py,sha256=R6VB-TTj31Ajr4lEaeYX4fqMbgX70IE0pcs_s_Z8394,7222
+agentskills_agentframework-0.1.0.dist-info/METADATA,sha256=xIgviuOwg9OGIW-N-y7_gcesmiWPKVUP_vyBgvNFDjE,3192
+agentskills_agentframework-0.1.0.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
+agentskills_agentframework-0.1.0.dist-info/RECORD,,

agentskills_agentframework-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.0
+Root-Is-Purelib: true
+Tag: py3-none-any