Skip to content

Latest commit

 

History

History
11 lines (6 loc) · 1.21 KB

File metadata and controls

11 lines (6 loc) · 1.21 KB

Skill usage example template (contributors)

When adding Usage Examples to docs/skills/<skill>.md, include subsections for Gemini, Claude, OpenAI, DeepSeek, and Ollama (prompt mode). Each block should be runnable: imports, load_env_file(), load_skill, bundle["class"]() (or explicit bundle["module"].ClassName()), adapter, system instructions, sample user message, and execute on tool call.

Add Recommended install: pip install "skillware[<category>_<skill>]" near the top of every catalog page (use the registry ID with / replaced by _, even when the extra is empty today).

For Gemini sections, ensure the dispatch matches the sanitized tool name (e.g. SkillLoader._sanitize_gemini_tool_name(bundle["manifest"]["name"]) or adapter-derived name) rather than the raw registry ID with slashes. Do not manually wrap the tool output in types.Tool(function_declarations=[...]), as to_gemini_tool() already returns a types.Tool object.

Link to agent_loops.md, install_extras.md, and README.md. List skill-specific env vars in an Environment table; link to api_keys.md for setup.

Do not duplicate the full API keys guide on skill pages.