Skip to content

API Reference

This section is the auto-generated reference for mirai-shared-skills's public Python surface. It is rendered from Google-style docstrings via mkdocstrings. For narrative guidance, see the skill pages and the guides.

The reference is split by surface area:

Page Covers
Foundational Skills discovery, execution, auth_gates, browser, pdf_extraction
Domain Skills agentic_rag (and providers), weather, database
Registry _registry.SkillDescriptor, register, find, bootstrap, all_descriptors

Architectural decisions

The reference documents what each class does. For why it does it that way, see the ADR index. In particular:

  • Every skill class exposes its tools via tool_from_function (ADR-0007).
  • Every skill is registered with a SkillDescriptor whose category is standard or raw (ADR-0001).
  • Provider classes follow Protocol types defined in mirai_shared_skills.agentic_rag.providers (ADR-0002).