malloy-document

Automate adding #(doc) tags to Malloy model sources and fields.

95|24|Updated Sep 16, 2024
One-click install
npx skills add https://github.com/malloydata/publisher --skill malloy-document
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: malloy-document
Source: https://github.com/malloydata/publisher/tree/main/skills/malloy-document
Command: npx skills add https://github.com/malloydata/publisher --skill malloy-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Malloy models often lack documentation for sources and fields, making it difficult to understand and use the models effectively.

Core Features & Use Cases

  • Documentation with #(doc) Tags: Automatically generate human-readable descriptions for Malloy model fields and sources.
  • Enhanced Searchability: Improve the searchability of Malloy models by making their contents more easily understandable.
  • Use Case: Add clear, concise documentation to Malloy models, so that analysts and AI agents can understand the models' data structure and usage more effectively.

Quick Start

Run the 'malloy-document' skill to add documentation to your Malloy model fields and sources.

Frequently Asked Questions about malloy-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add documentation to Malloy model fields and sources?▼

You can document Malloy models by running an automated annotation process that generates human-readable descriptions. This adds #(doc) tags directly to fields and sources, making the models easier to understand and search.

What is the best way to improve discoverability for Malloy models?▼

The best way to improve discoverability is by adding clear, concise documentation to sources and fields. Annotating Malloy models with #(doc) tags helps both analysts and AI agents understand the data structure and usage effectively.

How does adding #(doc) tags help with model discoverability?▼

Adding #(doc) tags enhances model discoverability by embedding human-readable descriptions directly into the data structure. This makes Malloy model contents more easily understandable for end-users and AI agents during search.

Can I automate the annotation of Malloy models with human-readable descriptions?▼

Yes, you can automate the annotation of Malloy models with human-readable descriptions. This process automatically generates #(doc) tags for sources and fields, enhancing the documentation capabilities and understandability of your models.

Why do my Malloy models lack understandability for AI agents?▼

Malloy models lack understandability for AI agents when they lack documentation for sources and fields. Adding clear descriptions through #(doc) tags makes the data structure and usage more easily understandable for automated agents.