Skip to content

Require current API documentation before shell calls - #45

Open
Sebastian Mertens Make (MAKESEB) wants to merge 1 commit into
integromat:mainfrom
MAKESEB:feat/api-shell-current-api-docs
Open

Require current API documentation before shell calls#45
Sebastian Mertens Make (MAKESEB) wants to merge 1 commit into
integromat:mainfrom
MAKESEB:feat/api-shell-current-api-docs

Conversation

@MAKESEB

Copy link
Copy Markdown
Contributor

Summary

  • require agents to retrieve current API docs/specs before drafting or executing provider calls
  • use Context7 first, then authoritative online provider docs or OpenAPI specs
  • verify endpoint, auth, request, pagination, response, and error contracts

Validation

  • git diff --check

Connected Code remains out of this PR and stays on MAKESEB:feat/make-connected-code-hosting-v2.

Require agents to consult Context7 first and fall back to authoritative online documentation before drafting or executing provider API calls.

Constraint: Keep the opening hint to no more than five lines

Rejected: Embed provider-specific documentation links | they become stale and cannot cover the generic shell

Confidence: high

Scope-risk: narrow

Tested: git diff --check

Not-tested: live provider API calls
Copilot AI review requested due to automatic review settings July 17, 2026 09:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an explicit “current API documentation” gating rule to the Make API shell workflow skill so agents verify up-to-date provider API contracts (preferably via Context7, otherwise official docs/OpenAPI) before drafting or executing shell calls.

Changes:

  • Introduces a new documentation gate requiring retrieval of current provider API specs/docs before making calls.
  • Specifies a preferred source order (Context7 → official provider docs/OpenAPI) and a checklist of contract items to verify.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +15 to +18
> **Current API documentation gate**
> Before drafting or executing a provider API call, retrieve current docs/specs for the exact API, app, module, version, and operation.
> Query Context7 first; if it has no authoritative match, search online and prefer official provider docs or OpenAPI specs.
> Verify the base URL, path/method, auth/scopes, parameters/body, pagination, and response/error shape; record the sources used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants