Skip to main content

​
Overview

OMOPHub provides documentation in three formats specifically designed for AI consumption. Each format serves a different use case depending on your context window budget and the depth of information your agent needs.

​
Documentation Formats

llms.txt

Concise index of the OMOPHub API. Fits in small context windows.

llms-full.txt

Complete documentation in a single file. Full API reference included.

skill.md

Structured skills reference for AI agents with action-oriented instructions.

​
When to Use Each Format

FormatSizeBest For
llms.txtSmallQuick orientation. Gives an agent a high-level map of available endpoints and capabilities. Use when context window space is limited.
llms-full.txtLargeDeep integration work. Contains the full API reference, parameter details, and response schemas. Use when the agent needs to write code against the API.
skill.mdMediumAction-oriented tasks. Structured as capabilities the agent can perform, with step-by-step instructions. Use for agents that follow skill/tool patterns.

​
Direct URLs

You can fetch these files directly for injection into your agent’s context: 
https://docs.omophub.com/llms.txt
https://docs.omophub.com/llms-full.txt
https://docs.omophub.com/skill.md

​
Usage Example

To give an AI agent access to OMOPHub documentation, include the appropriate file in the system prompt or context: 
import httpx

# Fetch the concise index for a small context window
response = httpx.get("https://docs.omophub.com/llms.txt")
llms_context = response.text

# Include in your agent's system prompt
system_prompt = f"""You are a medical coding assistant.
Use the following API documentation to look up medical concepts:

{llms_context}
"""