entity-creation — Claude Code skill for Honeydew entities and install
entity-creation walks the agent through defining a Honeydew entity from a warehouse source — source type, granularity key, initial attribute mapping — then pushes it to Honeydew via MCP tools.
Apache-2.0 ★ 44 updated 2026-08-30
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a claude-codeWhat entity-creation does
A Honeydew entity is a named, governed representation of a business concept at a fixed granularity; every metric and calculated attribute anchors to one. The skill frames creation as three questions: what the concept is, which column or columns make a row distinct, and which source columns to expose as attributes. Sources can be Snowflake, Databricks or BigQuery tables, views, custom SQL, or a virtual derivation from the semantic model.
There are two main creation paths. import_tables pulls warehouse tables straight in with columns mapped to attributes automatically, which is the fast route for bulk imports. create_entity is the recommended one: it takes YAML for the entity and the dataset and writes both in a single call — there is no simplified API here, YAML is always required. create_object covers the narrower case of adding a second dataset to an entity that already exists. A successful call returns ui_url, and the skill has the agent surface that link.
Before modeling, the agent checks session context with get_session_workspace_and_branch and can spin up a branch via create_workspace_branch. The skill also carries a pitfall list worth heeding: duplicated or nullable keys produce silently wrong joins, custom SQL blocks filter pushdown, and forgetting is_time_spine on a date dimension breaks time-aware metrics. Calculated attributes and joins are deliberately out of scope — they belong to attribute-creation and relation-creation.
What it helps with
- define a Honeydew entity over a warehouse table
- bulk-import warehouse tables into the semantic model
- set the granularity key and map columns to attributes
- attach a second dataset to an existing entity
- check the workspace and branch before modeling
Example prompts for the agent
- Create an orders entity from
ANALYTICS.PUBLIC.ORDERSwithorder_idas the key - Import
DB.RAW.CUSTOMERSandDB.RAW.PRODUCTSinto the semantic model - Add a customers entity backed by a custom SQL query and show me the Honeydew link
How to install entity-creation
1Skills CLI (Vercel)
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a claude-code2Manually: put the files in place
~/.claude/skills/entity-creation/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/entity-creation/
1Skills CLI (Vercel)
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a codex2Manually: put the files in place
.agents/skills/entity-creation/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a cursor2Manually: put the files in place
.cursor/skills/entity-creation/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install honeydew-ai/honeydew-ai-coding-agents-plugins skills/entity-creation2Manually: put the files in place
.github/skills/entity-creation/SKILL.md1Skills CLI (Vercel)
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a gemini-cli2Platform CLI
gemini skills install https://github.com/honeydew-ai/honeydew-ai-coding-agents-plugins --path skills/entity-creationManually: put the files in place
.devin/skills/entity-creation/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about entity-creation
How do I install entity-creation in Claude Code?
Run npx skills add honeydew-ai/honeydew-ai-coding-agents-plugins --skill entity-creation -a claude-code. The skill lands at ~/.claude/skills/entity-creation/SKILL.md.
What does entity-creation do?
It guides the agent through defining a Honeydew entity — warehouse source, granularity key, attribute mapping — and then publishes it through the MCP tools create_entity or import_tables.
When should I use create_entity instead of import_tables?
import_tables suits quick prototyping where the default column mapping is enough. create_entity needs YAML but creates the entity and its dataset in one call with full control over the definition.
Source text
SKILL.md · Apache-2.0
---
name: entity-creation
description: Guides you through defining a new Honeydew entity from a data warehouse source — covering source type, granularity key, and initial attribute mapping — then pushes to Honeydew via the MCP tools.
---
## Prerequisites
Before creating entities, ensure you are on the correct workspace and branch. Use `get_session_workspace_and_branch` to check the current session context. For development work, create a branch with `create_workspace_branch` (the session switches automatically). See the `workspace-branch` skill for the full workspace/branch tool reference.
---
## Overview
A Honeydew **entity** is the foundational modeling object — a named, governed representation of a business concept at a specific granularity. Every metric and calculated attribute is anchored to an entity. An entity maps to a data warehouse (Snowflake, Databricks, or BigQuery) table, view, custom SQL query, or a virtual derivation from the semantic model.
When creating an entity you are answering three questions:
1. **What is this?** — the business concept (orders, customers, products, locations)
2. **What makes a row unique?** — the granularity key (primary key column(s))
3. **What columns should be exposed?** — the initial attribute mapping from source columns
> This skill focuses on the entity shell: source, key, and attribute mapping.
> Use `attribute-creation` to add calculated attributes and `relation-creation` to wire up joins afterwards —
> see [After Validating: Hand Off to relation-creation](#after-validating-hand-off-to-relation-creation).
---
## Creation Methods
### Quick Import: import_tables
Use `import_tables` to quickly import one or more data warehouse tables into the semantic model.
Each table becomes an entity with its columns automatically mapped as attributes. This is the fastest way to bootstrap entities when you don't need custom YAML.
Parameters:
- `tables` — List of fully qualified table names in the format `<database>.<schema>.<table>`
Best for: bulk imports, quick prototyping, or when the default column-to-attribute mapping is sufficient.
### Primary: create_entity (Recommended)
Unlike metrics and attributes, entity creation always requires YAML — there is no simplified single-expression API. `create_entity` is the preferred MCP tool because it creates both the entity and its dataset in a **single operation**.
Parameters:
- `entity_yaml` — YAML defining the entity
- `dataset_yaml` — YAML defining the dataset
Required permission: Editor or higher.
### Alternative: create_object (Generic)
Use `create_object` only when creating an entity or dataset independently (e.g. adding a second dataset to an existing entity). Requires a separate call per object.
Parameters:
- `yaml_text` — YAML defining the object
### After Creation: Display the UI Link
After a successful `create_entity` or `create_object` call, the response includes a `ui_url` field. **Always display this URL to the user** so they can quickly open the object in the Honeydew application.
---
## Decision Flow
```
Need to create an entity?
│
├─► Quick import from warehouse table(s)? Default mapping is fine?
│ └─► Use import_tables ✓ (fastest)
│
├─► New entity + dataset together (most common)?
│ └─► Use create_entity ✓ (full control)
│
├─► Adding a second dataset to existing entity?
│ └─► Use create_object with dataset YAML only
│
└─► Updating an existing entity or dataset?
└─► Use update_object with YAML + object_key
(preserve existing field order — minimal diff)
Entity written?
└─► Validate it, then hand off to relation-creation for joins
```
---
## Examples
See [examples.md](examples.md) for full worked examples covering: physical table, custom SQL, virtual entity, time spine, update, and delete.
---
## Discovery Helpers
Use these MCP tools before creating entities:
- `list_entities` — List all entities in the model
- `get_entity` — Get detailed info for a specific entity (attributes, metrics, datasets, relations)
- `search_model` — Search for entities, fields, or other objects by name (use `search_mode: EXACT` for known names, `OR` for broad discovery)
- `list_databases` — List all databases in the connected data warehouse
- `list_schemas` — List schemas in a specific database
- `list_tables` — List warehouse tables (requires `database` and `schema` parameters)
- `get_table_info` — Get column details for a specific warehouse table
---
See [reference.md](reference.md) for: YAML schemas (entity + dataset), source types, and granularity key rules.
---
## Documentation Lookup
Use the `search_docs` and `query_docs_filesystem` tools from the `honeydew` MCP server to search the Honeydew documentation when:
- You need to understand entity source types (physical table, custom SQL, virtual entity) in more depth
- The user asks about granularity design, entity modeling patterns, or best practices
- You need guidance on advanced modeling configurations like time spines, composite keys, or multi-dataset entities
- The user asks about entity governance, ownership, or lifecycle
- The user needs advanced modeling patterns (e.g., slowly changing dimensions, snapshot entities, incremental models)
Search for topics like: "entities", "source types", "granularity", "time spine", "virtual entity", "custom SQL source".
---
## Best Practices
- **Always set `owner`** to identify the responsible team or person for governance and accountability.
- **One entity = one granularity.** Never mix row-level grains. If a table has order-level and line-item-level rows, model them as two separate entities.
- **Name entities after the business concept, not the table.** `orders` is better than `fact_orders` or `fct_orders_v2`.
- **Always expose foreign key columns as attributes.** FK columns (e.g. `customer_id` on orders) are required for Honeydew to resolve relations.
- **Set `timegrain` on every date/timestamp source column.** Omitting it leads to unexpected aggregation behavior in BI tools.
- **Prefer absolute table paths** (`DB.SCHEMA.TABLE`) to avoid ambiguity across environments.
- **Convention:** entity = `orders`, dataset = `orders_source`. Keeping names distinct prevents confusion in YAML.
---
## Common Pitfalls to Avoid
- **Non-unique or nullable keys.** Honeydew assumes keys are unique and non-null. Duplicates cause silent incorrect join results. Validate before modeling.
- **Using custom SQL when a physical table would do.** Custom SQL blocks filter pushdown. Use a domain-level filter instead and keep the entity on the physical table.
- **Skipping the key column in the attribute list.** The key column must be in the dataset attributes list or Honeydew cannot resolve it.
- **Composite keys on virtual entities.** Use `HASH()` to create a single synthetic key attribute instead.
- **Forgetting `is_time_spine` on your date dimension.** Time-aware metrics will not function without a designated time spine entity.
---
## MANDATORY: Validate After Creating
**After creating ANY entity, you MUST invoke the `validation` skill to test and validate.**
See `validation` skill for:
- How to verify entity exists via `list_entities`
- How to verify data flows via `get_data_from_fields`
- Sanity checks (row count, key uniqueness)
- When to alert the user about issues
**Quick validation:**
1. Verify entity exists using `list_entities`, filter for the new entity name.
2. Verify data flows using `get_data_from_fields` with:
- `metrics`: `["<entity>.count"]`
---
## After Validating: Hand Off to relation-creation
A validated entity is not yet reachable from the rest of the model: nothing joins to it, so no metric can cross into it and no filter propagates. `import_tables` is the sharp case, landing a batch of entities whose FK columns are mapped as attributes and connected to nothing.
**Once the entity has validated, invoke the `relation-creation` skill** to find the candidate joins and propose them. That skill owns the search, the modeling choices and the write; it will come back here if a junction table or a role-playing copy has to be created as an entity first.
Skip this only when the user declined relations, or when the entity is deliberately standalone (a config lookup, a static parameter table). Do not write a `relations:` block from here to save the round trip — every rule about which side holds it, and about `update_object` replacing the whole block, lives in `relation-creation`.
© honeydew-ai · Apache-2.0 · honeydew-ai/honeydew-ai-coding-agents-plugins