Open an OKF bundle
okf_open_bundleOpen an OKF bundle and get a summary of its concepts, types, groups, and health status. Start here to understand the bundle's structure and contents.
Instructions
Open an Open Knowledge Format bundle and describe what is in it. Start here.
An OKF bundle is a directory of markdown files with YAML frontmatter, each describing one concept — a dataset, table, metric, API, playbook, policy, or attested computation.
Args:
bundle_path (string): directory containing the bundle
response_format ('markdown' | 'json'): default 'markdown'
Returns: { "name": string, // bundle directory name "concept_count": number, "types": { [type: string]: number }, // concept count per OKF type "groups": [{ "group": string, "count": number }], // top-level directories "health_summary": { "broken_links": number, "missing_descriptions": number, "untyped": number, "stale": number, "aging": number, "undated": number, "unverified": number, "deprecated": number, "orphans": number } }
Examples:
Use when: "What's in the bundle at ./knowledge?" -> bundle_path="./knowledge"
Use when: you need the type names before filtering okf_list_concepts
Don't use when: you already know the concept id (use okf_get_concept)
Error Handling:
Returns a message naming the path if the directory does not exist
Returns a message explaining what a bundle is if the directory holds no concept docs
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bundle_path | Yes | Path to the OKF bundle directory (a folder of .md files). Absolute paths are safest. | |
| response_format | No | 'markdown' for reading, 'json' for machine processing | markdown |