Skip to content

armgit / ax

Public Imported from GitHub
0

Agent Executor (AX) is Google's open agentic orchestration runtime

Go

Add documentation about skills (#150)

Jaana Doganbd9100c2f375
diff --git a/README.md b/README.md
index 6e9edd0..bdbe0e3 100644
--- a/README.md
+++ b/README.md
@@ -306,9 +306,7 @@ Event logs use the `ExecutionEvent` message available in the protobuf.
### Skills
-AX includes built-in support for the agentskills.io discovery and execution protocol.
-
-The planner automatically discovers skills from `~/.agents/skills` by default (or a custom directory specified in `ax.yaml`). These skills are provided to the planner as tools, allowing it to seamlessly read skill instructions and execute their scripts.
+AX includes built-in support for Agent Skills. See [Skills](docs/skills.md) for more.
### Bash Tool
diff --git a/docs/skills.md b/docs/skills.md
new file mode 100644
index 0000000..7e6adca
--- /dev/null
+++ b/docs/skills.md
@@ -0,0 +1,37 @@
+# Skills
+
+AX has built-in support for [Agent Skills](https://agentskills.io).
+
+## Configuration
+
+By default, `SKILLS_DIR` or `~/.agents/skills` are used as the skills directory.
+
+To enable skills with a custom directory, you can set the `skills_dir` in your `ax.yaml` file:
+
+```yaml
+planner:
+ gemini:
+ model: "gemini-3-flash-preview"
+ timeout: "60s"
+ skills_dir: "./examples/skills"
+```
+
+## Example: Using the `emoji` Skill
+
+AX contains a sample `emoji` skill in `examples/skills/emoji`. If you run a task that matches the description of the skill, the planner will automatically activate it and execute its scripts!
+
+Run the following command in your terminal:
+
+```bash
+ax exec --input "Give me an emoji for happy"
+```
+
+The planner will:
+1. Discover the `emoji` skill.
+2. Determine that your query matches its description.
+3. Call `activate_skill` to load the instructions.
+4. Execute the `emoji` skill via text generation or script execution based on its instructions.
+
+### Custom Skills
+
+Refer to the [Agent Skills](https://agentskills.io) documentation for more information on how to create custom skills.
\ No newline at end of file