understand-source
Research and document APIs of a source system to enable connector implementation.
When & Why to Use This Skill
The 'understand-source' Claude skill is designed to accelerate the development of data integrations by automating the research and documentation of source system APIs. It provides a structured approach to identifying critical technical details such as authentication protocols, endpoint structures, data schemas, pagination logic, and incremental sync strategies, ensuring a smooth transition from discovery to connector implementation.
Use Cases
- Building Custom ETL Connectors: Streamline the initial research phase when developing new data pipelines for platforms like Airbyte, Meltano, or custom-built solutions.
- API Discovery and Reverse Engineering: Systematically document legacy or poorly documented internal APIs to facilitate system interoperability and modernization.
- Integration Feasibility Analysis: Quickly evaluate a third-party API's capabilities, including its support for incremental loading and rate limits, before committing to development.
- Technical Specification Drafting: Generate comprehensive API reference guides that engineering teams can use as a single source of truth during the implementation of data connectors.
| name | understand-source |
|---|---|
| description | Research and document APIs of a source system to enable connector implementation. |
Understand and Document Source
Description
This skill helps you create comprehensive API documentation for a new data source connector. It guides you through researching the source API, documenting endpoints, authentication, schemas, pagination, and incremental sync strategies.
Instructions
Read and follow prompts/understand_and_document_source.md