The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs - agent resources for embedding (#71108)
Jeff Bruemmer0cdcd2232c13
diff --git a/docs/README.md b/docs/README.mdindex 0d9c8e3f143..5e6dea3e994 100644--- a/docs/README.md+++ b/docs/README.md@@ -213,6 +213,7 @@ Metabase's reference documentation.- [SDK](./embedding/sdk/introduction.md)- [Full app embedding](./embedding/full-app-embedding.md)- [Securing embeds](./embedding/securing-embeds.md)+- [AI agent resources](./embedding/ai-agent-resources.md)### Configurationdiff --git a/docs/embedding/ai-agent-resources.md b/docs/embedding/ai-agent-resources.mdnew file mode 100644index 00000000000..3619c7711d1--- /dev/null+++ b/docs/embedding/ai-agent-resources.md@@ -0,0 +1,47 @@+---+title: AI agent resources for embedding+summary: Agent skills and llms.txt to help AI coding agents embed Metabase in your app.+---++# AI agent resources for embedding++If you use an AI coding agent, you can give the agent Metabase-specific context to help with embedding setup, upgrades, and migrations.++## Agent skills++We've developed some [agent skills](https://github.com/metabase/agent-skills) to give your AI agents step-by-step playbooks for specific embedding tasks.++### Available skills++| Skill | Description |+| ------------------------------- | -------------------------------------------------------------------------------------------- |+| [SDK version upgrade](https://skillsmp.com/skills/metabase-agent-skills-skills-metabase-modular-embedding-version-upgrade-skill-md) | Upgrade your modular embedding SDK, including changelog checks and breaking change handling. |+| [Full app → modular embedding](https://skillsmp.com/skills/metabase-agent-skills-skills-metabase-full-app-to-modular-embedding-upgrade-skill-md) | Migrate from full app embedding to modular embedding. |+| [Modular embedding → SDK (React)](https://skillsmp.com/skills/metabase-agent-skills-skills-metabase-modular-embedding-to-modular-embedding-sdk-upgrade-skill-md) | Migrate from script-based modular embedding to the React SDK. |+| [Static → guest embeds](https://skillsmp.com/skills/metabase-agent-skills-skills-metabase-static-embedding-to-guest-embedding-upgrade-skill-md) | Migrate from static (signed) embeds to guest embeds. |+| [SSO for embeds](https://skillsmp.com/skills/metabase-agent-skills-skills-metabase-embedding-sso-implementation-skill-md) | Set up SSO authentication for embedded Metabase. _(In development.)_ |++Browse all skills on the [agent skills repo](https://github.com/metabase/agent-skills).++## llms.txt++Agents can read the docs you're reading now (and many agents have already read our docs), but we also publish llms.txts so that you can give your AI agent:++- [Summary of embedding docs, with links](https://www.metabase.com/docs/llms.txt).+- [The full embedding docs](https://www.metabase.com/docs/llms-embedding-full.txt).++If you're on a specific version (e.g., v0.58), you can use versioned llms.txt files scoped to that version's docs:++- `https://www.metabase.com/docs/v0.58/llms.txt`+- `https://www.metabase.com/docs/v0.58/llms-embedding-full.txt`++## Agents are not magic++Always review and validate the changes made by agents. Check that your application builds, tests pass, and the embedding works as expected before committing anything.++## Further reading++- [Embedding introduction](./introduction.md)+- [Modular embedding SDK](./sdk/introduction.md)+- [Upgrading the modular embedding SDK](./sdk/upgrade.md)+- [Agent skills repo](https://github.com/metabase/agent-skills)diff --git a/docs/embedding/introduction.md b/docs/embedding/introduction.mdindex 1e707f1ba88..2ddeba12dbe 100644--- a/docs/embedding/introduction.md+++ b/docs/embedding/introduction.md@@ -67,7 +67,7 @@ If you'd like to share your data with the good people of the internet, admins ca| Charts and dashboards | ✅ | ✅ | ✅ | ✅ | ✅ || [Filter widgets](https://www.metabase.com/glossary/filter-widget) | ✅ | ✅ | ✅ | ✅ | ✅ || Export results\* | ✅ | ✅ | ✅ | ✅ | ✅ |-| [Locked filters](./static-embedding-parameters.md#restricting-data-in-a-static-embed-with-locked-parameters) | ❌ | ❌ | ✅ | ❌ | ❌ |+| [Locked filters](./static-embedding-parameters.md#restricting-data-in-a-static-embed-with-locked-parameters) | ❌ | ❌ | ✅ | ❌ | ❌ || [Data segregation](../permissions/embedding.md) | ✅ | ✅ | ❌ | ✅ | ❌ || [Drill-through menu](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through) | ✅ | ✅ | ❌ | ✅ | ❌ || [Query builder](../questions/query-builder/editor.md) | ✅ | ✅ | ❌ | ✅ | ❌ |@@ -84,6 +84,10 @@ If you'd like to share your data with the good people of the internet, admins ca\*\* Requires a [Pro and Enterprise](https://www.metabase.com/pricing/) plan for any embedding type.+## Resources for AI agents++If you're using an AI agent to help you embed Metabase in your app, check out [AI agent resources](./ai-agent-resources.md).+## Further reading- [Strategies for delivering customer-facing analytics](https://www.metabase.com/learn/metabase-basics/embedding/overview).diff --git a/docs/embedding/sdk/upgrade.md b/docs/embedding/sdk/upgrade.mdindex 4282c37a38a..837c613019d 100644--- a/docs/embedding/sdk/upgrade.md+++ b/docs/embedding/sdk/upgrade.md@@ -7,6 +7,8 @@ summary: How to upgrade your Metabase and modular embedding SDK versions, test tHere's a basic overview of the steps you'll want to take when upgrading your SDK.+> **Using an AI coding agent?** The [agent skills pack](../ai-agent-resources.md) includes a skill that walks your agent through SDK upgrades step by step.+## 1. Read the release post and changelog for Metabase and the modular embedding SDK- [Release posts](https://www.metabase.com/releases) give a good overview of what's in each release, and call out breaking changes (which are rare).diff --git a/docs/embedding/start.md b/docs/embedding/start.mdindex 4d698046ecc..b58bb50cee0 100644--- a/docs/embedding/start.md+++ b/docs/embedding/start.md@@ -51,3 +51,7 @@ Admins can also create unsecured public links or embeds of questions and dashboa## [Securing embeds](./securing-embeds.md)How to make sure the right people can see the right data in your embedded Metabase.++## [AI agent resources](./ai-agent-resources.md)++Machine-readable docs and agent skills to help AI coding agents with embedding setup, upgrades, and migrations.