scaffold-connector

Generate OpenMetadata connector code from JSON schema definitions.

2|Updated Jul 18, 2023
One-click install
npx skills add https://github.com/Jason-Clark-FG/OpenMetadata-FG --skill scaffold-connector
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scaffold-connector
Source: https://github.com/Jason-Clark-FG/OpenMetadata-FG/tree/main/skills/connector-building
Command: npx skills add https://github.com/Jason-Clark-FG/OpenMetadata-FG --skill scaffold-connector

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of new connectors for OpenMetadata, significantly reducing the boilerplate code and setup time required for developers.

Core Features & Use Cases

  • Schema-First Development: Define your connector's configuration once in a JSON Schema, and the Skill generates code across Python, Java, and TypeScript, plus UI forms.
  • AI-Assisted Development: Generates a CONNECTOR_CONTEXT.md file to guide AI coding assistants throughout the implementation process.
  • Use Case: A developer needs to add a new connector for a niche database. Instead of manually creating all the configuration files, Python classes, and documentation stubs, they use this Skill to generate 80% of the work in minutes, allowing them to focus on the core integration logic.

Quick Start

Use the scaffold connector skill to create a new connector for the 'clickhouse' database.

Frequently Asked Questions about scaffold-connector

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

FAQPage Schema
How do I generate an OpenMetadata connector from a JSON schema?

You can generate an OpenMetadata connector by defining your configuration in a JSON Schema, which automates the creation of Python boilerplate, Java models, TypeScript types, and UI forms. This schema-first approach significantly reduces manual setup time for new database or API connectors.

What is schema-first development for data connectors?

Schema-first development for data connectors is an approach where you define your connector configuration in a JSON Schema first. This schema automatically generates Python boilerplate, Java models, TypeScript types, and UI forms, ensuring consistency across multiple programming languages.

Can I generate TypeScript types and Python boilerplate for OpenMetadata connectors?

Yes, you can generate TypeScript types and Python boilerplate for OpenMetadata connectors. The scaffolding process uses your JSON Schema configuration to automatically generate these artifacts alongside Java models and UI forms for your service.

Does OpenMetadata connector scaffolding support messaging and pipeline service types?

Yes, OpenMetadata connector scaffolding supports messaging and pipeline service types. It also handles database, dashboard, mlmodel, storage, search, and API connectors, allowing you to generate boilerplate across these service categories.

How do I use AI coding assistants to build data integration connectors?

To use AI coding assistants to build data integration connectors, generate a CONNECTOR_CONTEXT.md file during scaffolding. This AI context file guides your assistant through the implementation process after the initial Python boilerplate and TypeScript types are created.