Metadata-Version: 2.5
Name: ohdsi-prompt-registry
Version: 0.4.0
Summary: Groundworkers registry for agent-facing OHDSI prompt packs.
Requires-Python: >=3.12
Requires-Dist: groundworkers[tui]<1,>=0.7
Requires-Dist: jsonschema<5,>=4
Requires-Dist: mcp<2,>=1
Requires-Dist: oa-configurator<3,>=2.0
Requires-Dist: pydantic<3,>=2
Requires-Dist: pyyaml>=6
Provides-Extra: dev
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocs<2.0; extra == 'dev'
Requires-Dist: mkdocstrings[python]; extra == 'dev'
Requires-Dist: pygments>=2.20.0; extra == 'dev'
Requires-Dist: pytest<10,>=9; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: ty>=0.0.59; extra == 'dev'
Description-Content-Type: text/markdown

# OHDSI Prompt Registry

Reusable prompt packs for agents working through Groundworkers. A pack brings together instructions and, where useful, examples, structured contracts, and review formats for a defined task.

Start with the decision you need to make:

> Find a prompt pack to help us turn our study idea into a research question. Explain its scope and ask about the information we still need to provide.

The registry makes packs discoverable through MCP. Your agent applies the guidance, asks questions, and uses the available domain tools. Workflow guidance coordinates decisions; user elicitation collects answers; domain guidance determines what makes a result suitable. These responsibilities can be combined without making every clarification a full workflow.

Core instructions can be read on their own, with orientation and examples available separately. JSON Schemas are useful for structured handoffs, but a valid document still needs the relevant scientific or operational review.

## Documentation

Start with the [user guide](https://AustralianCancerDataNetwork.github.io/ohdsi-prompt-registry/).

For study-design work, see [Working on a research question](docs/research-questions.md).

- [Questions and workflow decisions](docs/interactions.md): clarification, uncertainty, and changed answers.
- [Pack sources](docs/sources.md): shared packs, local content, and overrides.
- [Authoring a prompt pack](docs/pack-format.md): instructions, optional explanations, and contracts.
- [Tools and structured handoffs](docs/tool-reference.md): MCP calls and validation behaviour.
- [Development](docs/development.md): local checks, documentation builds, and releases.

Python integrations are covered by the [API reference](docs/reference.md). Contribution and labelling rules are in [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md).
