connection-schema-design

What problem does it solve?

Designing connectionProfile.yml and connectionState.yml schemas can be error-prone without a clear, consistent rule set. This skill provides explicit guidelines to ensure schemas always extend core profiles, properly reference base states, and avoid scope leakage.

Core Features & Use Cases

• Extends core profiles: Always extend a core profile (tokenProfile.yml, oauthClientProfile.yml, oauthTokenProfile.yml, or basicConnection.yml) instead of creating custom ones.
• Mandatory base state extension: connectionState MUST extend baseConnectionState.yml to include expiresIn for token lifecycle management.
• expiresIn in seconds: Use expiresIn (integer seconds) rather than expiresAt to schedule refresh operations.
• Core profile/state selection: Provides a decision tree to select the appropriate core profile and state depending on credentials and needs.
• Common patterns: Demonstrates typical patterns for token-based or OAuth flows and how to compose profiles and states.

Quick Start

Apply these rules when drafting your first connectionProfile.yml and connectionState.yml to ensure proper core profile extension and state management.