mz-docs

Name: mz-docs
Author: materializeinc

github.com/materializeincData & databases3114 installsUpdated 1d ago

About mz-docs

mz-docs is a documentation skill for Materialize, aimed at users seeking guidance on its streaming database and SQL. It organizes reference material across ingestion, transformation, operations, deployment, and serving results.

Key features

01Materialize SQL command reference
02Guidance on ingestion and data export
03Cluster and deployment documentation
04Monitoring and troubleshooting topics

Use cases

01Finding syntax for Materialize SQL commands
02Planning data ingestion or export
03Configuring or troubleshooting clusters
04Looking up deployment and monitoring guidance

MCP support

The documentation index includes a section on Materialize MCP servers and agent skills. It does not specify MCP capabilities or behavior.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/materializeinc/agent-skills --skill mz-docs

After installing, type/mz-docsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

clusters/

index.md

clusters/autoscaling/

index.md

clusters/m1-cc-mapping/

index.md

clusters/operational-guidelines/

index.md

clusters/operational-guidelines/appendix-alternative-cluster-architectures/

index.md

clusters/optimize-hydration-requirements/

index.md

clusters/sizing/

index.md

clusters/system-clusters/

index.md

clusters/troubleshoot-clusters/

index.md

clusters/troubleshoot-clusters/cpu-troubleshooting/

index.md

clusters/troubleshoot-clusters/hydration-failures/

index.md

clusters/troubleshoot-clusters/memory-spike/

index.md

developer-tools/

index.md

developer-tools/console/

index.md

developer-tools/console/admin/

index.md

developer-tools/console/clusters/

index.md

developer-tools/console/connect/

index.md

developer-tools/console/create-new/

index.md

developer-tools/console/data/

index.md

developer-tools/console/integrations/

index.md

developer-tools/console/monitoring/

index.md

developer-tools/console/sql-shell/

index.md

developer-tools/console/user-profile/

index.md

developer-tools/dbt/

index.md

developer-tools/dbt/blue-green-deployments/

index.md

developer-tools/dbt/development-workflows/

index.md

developer-tools/dbt/get-started/

index.md

developer-tools/dbt/slim-deployments/

index.md

developer-tools/install-materialize-emulator/

index.md

developer-tools/integrations/

index.md

Details

From the project README

Materialize Documentation

This skill provides comprehensive documentation for Materialize, a streaming database for real-time analytics.

How to Use This Skill

When a user asks about Materialize:

For SQL syntax/commands: Read files in the sql/ directory
For core concepts: Read files in the fundamentals/concepts/ directory
For data ingestion: Read files in the ingest-data/ directory
For transformations: Read files in the transform-data/ directory

Documentation Sections

Clusters

Guidance for configuring and operating Materialize clusters.

Autoscaling for hydration: clusters/autoscaling/index.md
M.1 to cc size mapping: clusters/m1-cc-mapping/index.md
Operational guidelines: clusters/operational-guidelines/index.md
Optimize hydration requirements: clusters/optimize-hydration-requirements/index.md
Size clusters for hydration: clusters/sizing/index.md
System clusters: clusters/system-clusters/index.md
Troubleshoot clusters: clusters/troubleshoot-clusters/index.md

Developer tools

Tools for developing, deploying, and managing Materialize.

Download and run Materialize Emulator: developer-tools/install-materialize-emulator/index.md
Manage Materialize: developer-tools/manage/index.md
Materialize console: developer-tools/console/index.md
MCP Servers and agent skills: developer-tools/mcp-server/index.md
mz-debug: developer-tools/mz-debug/index.md
Tools and integrations: developer-tools/integrations/index.md
Use dbt to manage Materialize: developer-tools/dbt/index.md
Use mz-deploy to manage Materialize: developer-tools/mz-deploy/index.md
Use Terraform to manage Materialize: developer-tools/terraform/index.md

Ingest data

Best practices for ingesting data into Materialize from external systems.

Amazon EventBridge: ingest-data/webhooks/amazon-eventbridge/index.md
AWS PrivateLink connections (Cloud-only): ingest-data/network-security/privatelink/index.md
Change a webhook source's included headers: ingest-data/webhooks/change-included-headers/index.md
CockroachDB CDC using Kafka and Changefeeds: ingest-data/cdc-cockroachdb/index.md
Debezium: ingest-data/debezium/index.md
Fivetran: ingest-data/fivetran/index.md
HubSpot: ingest-data/webhooks/hubspot/index.md
Ingestion performance: ingest-data/performance/index.md
Kafka: ingest-data/kafka/index.md
MongoDB: ingest-data/mongodb/index.md
(and 16 more files in this section)

Materialize Cloud

Guidance for operating Materialize Cloud.

Customer responsibility model (Cloud): materialize-cloud/customer-responsibilities/index.md
Disaster recovery (Cloud): materialize-cloud/disaster-recovery/index.md
Free Trials: materialize-cloud/free-trials/index.md
Usage & billing (Cloud): materialize-cloud/billing/index.md

Monitoring and alerting

Monitor the performance of your Materialize region with Datadog and Grafana.

Appendix: Metrics: observability/appendix-metrics/index.md
Cloud: observability/cloud/index.md
Essential metrics: observability/essential-metrics/index.md
Replica resource usage: observability/replica-resource-usage/index.md
Self-Managed: observability/self-managed/index.md

Overview

Learn how to efficiently transform data using Materialize SQL.

Dataflow troubleshooting: transform-data/dataflow-troubleshooting/index.md
Dictionary compression: transform-data/dictionary-compression/index.md
FAQ: Indexes: transform-data/faq/index.md
Freshness troubleshooting: transform-data/freshness-troubleshooting/index.md
How to monitor freshness in Materialize: transform-data/monitor-freshness/index.md
Idiomatic Materialize SQL: transform-data/idiomatic-materialize-sql/index.md
Optimization: transform-data/optimization/index.md
Patterns: transform-data/patterns/index.md
Updating materialized views: transform-data/updating-materialized-views/index.md

Security

Appendix: security/appendix/index.md
Cloud: security/cloud/index.md
Patterns: security/patterns/index.md
Self-managed: security/self-managed/index.md

Self-Managed Deployments

Learn about the key components and architecture of self-managed Materialize deployments.

Appendix: self-managed-deployments/appendix/index.md
Configure single sign-on: self-managed-deployments/sso/index.md
Configuring System Parameters: self-managed-deployments/configuration-system-parameters/index.md
Deployment guidelines: self-managed-deployments/deployment-guidelines/index.md
FAQ: self-managed-deployments/faq/index.md
Installation: self-managed-deployments/installation/index.md
Materialize CRD Field Descriptions: self-managed-deployments/materialize-crd-field-descriptions/index.md
Materialize Operator Configuration: self-managed-deployments/operator-configuration/index.md
Query History: self-managed-deployments/query-history/index.md
Self-managed release versions: self-managed-deployments/release-versions/index.md
(and 3 more files in this section)

Serve results

Serving results from Materialize

SELECT and SUBSCRIBE: serve-results/query-results/index.md
ADBC (Arrow Database Connectivity): serve-results/adbc/index.md
Client libraries: serve-results/client-libraries/index.md
Connect to Materialize via HTTP: serve-results/http-api/index.md
Connect to Materialize via WebSocket: serve-results/websocket-api/index.md
Connection Pooling: serve-results/connection-pooling/index.md
Durable subscriptions: serve-results/durable-subscriptions/index.md
**Foreign data wrapper (FDW) **: serve-results/fdw-setup/index.md
Isolation levels: serve-results/isolation-level/index.md
SQL clients: serve-results/sql-clients/index.md
(and 4 more files in this section)

Sink results

Sinking results from Materialize to external systems.

Amazon S3: export-data/s3/index.md
Apache Iceberg: export-data/iceberg/index.md
AWS S3 Tables: export-data/iceberg-aws/index.md
Census: export-data/census/index.md
Consume from Snowflake on AWS S3 Tables: export-data/iceberg-aws-snowflake/index.md
Databricks Unity Catalog: export-data/iceberg-databricks/index.md
Elasticsearch: export-data/elasticsearch/index.md
GCP BigLake: export-data/iceberg-gcp/index.md
Kafka and Redpanda: export-data/kafka/index.md
OpenSearch: export-data/opensearch/index.md
(and 5 more files in this section)

SQL commands

SQL commands reference.

Namespaces: sql/namespaces/index.md
ALTER CLUSTER: sql/alter-cluster/index.md
ALTER CLUSTER REPLICA: sql/alter-cluster-replica/index.md
ALTER CONNECTION: sql/alter-connection/index.md
ALTER DATABASE: sql/alter-database/index.md
ALTER DEFAULT PRIVILEGES: sql/alter-default-privileges/index.md
ALTER INDEX: sql/alter-index/index.md
ALTER MATERIALIZED VIEW: sql/alter-materialized-view/index.md
ALTER NETWORK POLICY (Cloud): sql/alter-network-policy/index.md
ALTER ROLE: sql/alter-role/index.md
(and 111 more files in this section)

What is Materialize?

Learn more about Materialize

Architecture Patterns: fundamentals/architecture-patterns/index.md
Concepts: fundamentals/concepts/index.md

Quick Reference

Common SQL Commands

Command	Description
`CREATE SOURCE`	Connect to external data sources (Kafka, PostgreSQL, MySQL)
`CREATE MATERIALIZED VIEW`	Create incrementally maintained views
`CREATE INDEX`	Create indexes on views for faster queries
`CREATE SINK`	Export data to external systems
`SELECT`	Query data from sources, views, and tables

Key Concepts

Sources: Connections to external data systems that stream data into Materialize
Materialized Views: Views that are incrementally maintained as source data changes
Indexes: Arrangements of data in memory for fast point lookups
Clusters: Isolated compute resources for running dataflows
Sinks: Connections that export data from Materialize to external systems

Comments

Markdown supported

Details

Author: materializeinc
Repository: materializeinc/agent-skills
Category: Data & databases
Installs: 114
GitHub stars: 3

Report

More skills

All skills

hyperframes-core

github.com/heygen-com

930.7k

The HyperFrames composition contract — build one renderable project. Use for composition structure, the `data-*` timing attributes, `class="clip"`, tracks, sub-compositions, variables, framework-owned media playback, deterministic-render rules, and validation. Also covers Tailwind projects and the STORYBOARD.md / SCRIPT.md plan formats. Read before writing composition HTML.

lark-base

open.feishu.cn

837.7k

Operate on Feishu Base: create tables, fields, records, and views; handle statistics, formulas/lookups, forms, dashboards, app mode (BaseApp/AppMode pages and components), Workspace directories, workflows, role permissions, and the template center (Base template categories, lists, and search). Use when encountering Base/multidimensional tables/bitable, BaseApp/AppMode, or /base/ or /app/ links. Do not use lark-apps for BaseApp; route file import/export to lark-drive and authentication/authorization to lark-shared.

lark-sheets

open.feishu.cn

836.2k

Feishu Spreadsheets: create and operate spreadsheets. Supports worksheets and row/column structures (add/delete/merge/size/hide/freeze/group), cell read/write (values/formulas/styles/comments/cell images), range copy/move/sort/fill, find and replace, bulk updates, and creating and maintaining objects such as charts, pivot tables, conditional formatting, filters and filter views, dropdown lists, sparklines, and floating images. Also supports formula validation, restoring historical versions, and importing/exporting local Excel/CSV files and Feishu spreadsheets. Use when users need to create or edit spreadsheets, summarize and visualize data, format spreadsheets, calculate formulas (including migrating Excel formulas), or build financial models (DCF, three statements, budgets, Sensitivity, etc.). For multidimensional tables (Base/bitable), use lark-base. If users want to search for spreadsheet files in cloud storage (Drive/cloud storage) by name or keyword, use lark-drive's drive +search to locate resources first. When users provide a doubao.com /sheets/ URL/token, use this skill directly; do not fall back to WebFetch because the domain is not Feishu. Routing is based on the URL path pattern and token, not the domain.

remotion-best-practices

github.com/remotion-dev

720.7k

Best practices and domain knowledge for building videos programmatically with Remotion (videos in React/TypeScript, rendered to MP4). Use whenever writing or editing Remotion code — scaffolding a video project, animating with interpolate/spring over useCurrentFrame(), sequencing scenes and transitions, captions/subtitles, audio, GIFs/Lottie/3D, charts, visual effects, dynamic duration via calculateMetadata, or rendering. Consult before reaching for a Remotion API, since its components and props evolve (e.g. @remotion/media).