agentleFS
korchard333korchard333/claude-power-platform-community/.claude/skills/custom-connectors/SKILL.md

custom-connectors

Skill46 starsChanged 8 months agoMITView on GitHub

Custom Connectors for Power Platform. Use when: building custom connectors, OpenAPI definitions, OAuth authentication, API Key auth, triggers (polling/webhook), connector policies, Azure APIM integration, DLP considerations.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 4 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Always use x-ms-summary on every parameter and property (maker-friendly display names)

    line 54
  2. Very specific:

    Always set x-ms-visibility: "internal" for technical parameters users shouldn't see

    line 55
  3. Distinctive:

    Always define response schemas (Power Automate needs them for dynamic content)

    line 56
  4. Very specific:

    Use x-ms-dynamic-values for dropdown parameters (don't force users to type GUIDs)

    line 57
  5. Distinctive:

    Test with both Power Automate and Canvas App (behaviour can differ)

    line 58
  6. Distinctive:

    Not classifying connector in DLP policy (blocks use with Dataverse/SharePoint)

    line 70
  7. Distinctive:

    Not including connector in solution (breaks ALM)

    line 72

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill: Custom Connectors

When to Use

Trigger when building, configuring, or debugging custom connectors — reusable API wrappers that expose REST APIs as Power Platform connectors for use in Power Automate, Power Apps, and Copilot Studio.


When to Use Custom Connectors vs Alternatives

ScenarioUseWhy
Standard connector existsStandard connectorZero maintenance, Microsoft-supported
REST API used in one flow onlyHTTP action in Power AutomateSimpler, no connector overhead
REST API used across multiple flows/appsCustom connectorReusable, typed, discoverable
REST API with complex auth (OAuth 2.0)Custom connectorAuth handled once, shared across all uses
High-volume API calls needing throttlingCustom connector + Azure APIMAPIM handles rate limiting, caching, monitoring
On-premises API (no public endpoint)Custom connector + On-premises Data GatewayGateway bridges private network

Project Structure

custom-connectors/
  contoso-erp/
    apiDefinition.swagger.json    # OpenAPI 2.0 definition
    apiProperties.json            # Connector metadata + policies
    icon.png                      # 160x160 connector icon
    settings.json                 # Test settings
  README.md

⚠️ REQUIRED: Load Sub-Files Before Implementation

SKILL.md is a summary only — it is NOT sufficient for implementation.

The detailed content (complete payloads, XML templates, working examples, edge-case handling) lives in sub-files in the same directory as this SKILL.md. Before writing any code, you MUST use read_file on the sub-files relevant to your task:

  • OpenAPI Definition — Swagger structure, action definitions, schema definitions, x-ms extensions, dynamic values/schema
  • Authentication — API Key, OAuth 2.0 (Authorization Code), Azure AD / Entra ID, apiProperties.json configuration
  • Triggers — Polling triggers (batch), webhook triggers, deregistration endpoint, trigger hints
  • Policies & APIM — Connector policies (set header, route request), Azure APIM integration, DLP classification, CLI workflow, solution-aware connectors

Best Practices

  • Always use x-ms-summary on every parameter and property (maker-friendly display names)
  • Always set x-ms-visibility: "internal" for technical parameters users shouldn't see
  • Always define response schemas (Power Automate needs them for dynamic content)
  • Use x-ms-dynamic-values for dropdown parameters (don't force users to type GUIDs)
  • Test with both Power Automate and Canvas App (behaviour can differ)
  • Version your connector: host + basePath should include version (e.g., /v2/)
  • Icon must be exactly 160x160px PNG with brand colour background

Anti-Patterns

  • Missing x-ms-summary on parameters (users see raw field names)
  • Missing response schemas (dynamic content unavailable in flow designer)
  • Using x-ms-visibility: "internal" on required user inputs (hides needed fields)
  • Hardcoded hostnames in OpenAPI definition (use connection parameter for environment switching)
  • Not classifying connector in DLP policy (blocks use with Dataverse/SharePoint)
  • Polling triggers without proper 202 handling (triggers fire with empty data)
  • Not including connector in solution (breaks ALM)
  • Using Basic auth for production connectors (use OAuth 2.0 or API key)
  • Missing error response definitions (poor error handling in flows)

Related Skills

  • power-automate — Flows consume custom connectors as actions and triggers
  • code-apps — Code Apps can use connectors via pac code add-data-source -c
  • dataverse-web-api — Alternative when data lives in Dataverse (no connector needed)
  • alm — Solution packaging and deployment of custom connectors

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.