andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-05-01 07:13:00 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

chore: cleanup dead code, docs

Browse Source
This commit is contained in:
Greyson Lalonde
2026-03-05 20:37:32 -05:00
parent bb126d54e5
commit a940623672
8 changed files with 95 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs.json
View File

@@ -148,6 +148,7 @@
"en/concepts/flows",
"en/concepts/production-architecture",
"en/concepts/knowledge",
"en/concepts/skills",
"en/concepts/llms",
"en/concepts/files",
"en/concepts/processes",
@@ -607,6 +608,7 @@
"en/concepts/flows",
"en/concepts/production-architecture",
"en/concepts/knowledge",
"en/concepts/skills",
"en/concepts/llms",
"en/concepts/files",
"en/concepts/processes",

50
docs/en/concepts/skills.mdx
View File

@@ -28,26 +28,29 @@ The directory name must match the `name` field in `SKILL.md`.
```markdown
---
name: my-skill
description: Short description of what this skill does.
description: Short description of what this skill does and when to use it.
license: Apache-2.0 # optional
compatibility: crewai>=0.1.0 # optional
metadata: # optional
author: your-name
version: "1.0"
allowed_tools: # optional
- web-search
- file-read
allowed-tools: web-search file-read # optional, space-delimited
---
Instructions for the agent go here. This markdown body is injected
into the agent's prompt when the skill is activated.
```
### Name Constraints
### Frontmatter Fields
- 1–64 characters
- Lowercase alphanumeric and hyphens only
- No leading, trailing, or consecutive hyphens
| Field | Required | Constraints |
| :-------------- | :------- | :----------------------------------------------------------------------- |
| `name` | Yes | 1–64 chars. Lowercase alphanumeric and hyphens. No leading/trailing/consecutive hyphens. Must match directory name. |
| `description` | Yes | 1–1024 chars. Describes what the skill does and when to use it. |
| `license` | No | License name or reference to a bundled license file. |
| `compatibility` | No | Max 500 chars. Environment requirements (products, packages, network). |
| `metadata` | No | Arbitrary string key-value mapping. |
| `allowed-tools` | No | Space-delimited list of pre-approved tools. Experimental. |
## Usage
@@ -103,32 +106,11 @@ agent = Agent(
Skills load progressively through three levels:
| Level | What's loaded | When |
|---|---|---|
| `METADATA` | Name, description, frontmatter fields | `discover_skills()` |
| `INSTRUCTIONS` | Full SKILL.md body text | `activate_skill()` |
| `RESOURCES` | File listings from scripts/, references/, assets/ | `load_resources()` |
| Level | What's loaded | When |
| :--------------- | :------------------------------------------------ | :----------------- |
| `METADATA` | Name, description, frontmatter fields | `discover_skills()` |
| `INSTRUCTIONS` | Full SKILL.md body text | `activate_skill()` |
| `RESOURCES` | File listings from scripts/, references/, assets/ | `load_resources()` |
During normal agent execution, skills are automatically discovered and activated (promoted to `INSTRUCTIONS`). Use `load_resources()` only when you need to inspect available files programmatically.
## Events
Skill operations emit events via the CrewAI event bus:
| Event | When |
|---|---|
| `SkillDiscoveryStartedEvent` | Discovery scan begins |
| `SkillDiscoveryCompletedEvent` | Discovery scan finishes |
| `SkillLoadedEvent` | A skill is loaded at metadata level |
| `SkillActivatedEvent` | A skill is promoted to instructions level |
| `SkillLoadFailedEvent` | A skill fails to load |
```python
from crewai.events import BaseEventListener, SkillActivatedEvent
class SkillLogger(BaseEventListener):
def setup_listeners(self, crewai_event_bus):
@crewai_event_bus.on(SkillActivatedEvent)
def on_activated(source, event):
print(f"Activated: {event.skill_name}")
```