mcpField
A
api-patterns

api-patterns

github.com/redpanda-dataDevelopment4.3k51 installsUpdated 3d ago
Repository

About api-patterns

api-patterns is a coding skill for making API calls with Connect Query. It guides developers on data fetching, mutations, cache invalidation, error notifications, and generated Protobuf files.

Key features

  1. 01Guidance for Connect Query hooks
  2. 02Cache invalidation after mutations
  3. 03Error messages with formatToastErrorMessage
  4. 04Rules for generated Protobuf files

Use cases

  1. 01Fetch API data with Connect Query
  2. 02Update cached data after a mutation
  3. 03Show formatted mutation errors
  4. 04Avoid editing generated Protobuf files

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/redpanda-data/console --skill api-patterns

After installing, type/api-patternsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

rules/
api-invalidate-cache.md
api-toast-errors.md
protobuf-no-edit.md
use-connect-query.md

Details

From the project README

API Patterns

Make API calls with Connect Query and handle responses properly.

Activation Conditions

  • Making API calls
  • Using Connect Query hooks
  • Cache invalidation
  • Mutations and optimistic updates
  • Toast notifications for errors

Quick Reference

ActionRule
Fetch datause-connect-query.md
After mutationapi-invalidate-cache.md
Handle errorsapi-toast-errors.md (use formatToastErrorMessage in onError)
Protobuf filesprotobuf-no-edit.md

Key Locations

LocationPurpose
/src/react-query/Connect Query hooks
/src/protogen/Generated protos (DO NOT EDIT)

Regenerate protos: task proto:generate (from repo root)

Rules

See rules/ directory for detailed guidance on queries, mutations, cache invalidation, and error handling.

Comments

Markdown supported