API Reference Documentation Writer

Generate and update Medusa API reference documentation in Markdown (MDX) format.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/AnikAKB/dps --skill api-reference-documentation-writer-anikakb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API Reference Documentation Writer
Source: https://github.com/AnikAKB/dps/tree/main/distributed-payment-system/.claude/skills/api-ref-doc
Command: npx skills add https://github.com/AnikAKB/dps --skill api-reference-documentation-writer-anikakb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and updating of API reference documentation for the Medusa ecommerce platform, ensuring consistency and accuracy across Admin API, Store API, and client libraries.

Core Features & Use Cases

  • Automated Documentation Generation: Leverages OpenAPI specs to auto-generate route documentation.
  • Manual Content Creation: Supports hand-written MDX for common patterns, authentication, and custom explanations.
  • Component-Based Structure: Utilizes React components for a consistent and maintainable documentation structure.
  • Multi-language Examples: Integrates JS SDK and cURL examples for comprehensive API usage.
  • Use Case: Update the authentication section for the Store API by adding details about the Publishable API Key and providing new JS SDK and cURL examples.

Quick Start

Ask the API Reference Documentation Writer to add a new section on "Pagination" to the store.mdx file.

Frequently Asked Questions about API Reference Documentation Writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API reference documentation for Medusa?

To generate API reference documentation for Medusa, this Skill utilizes OpenAPI specifications to automatically create route documentation in Markdown (MDX) format. It structures content using React components for consistent formatting and maintainability.

Can I write custom MDX explanations for Medusa API endpoints?

Yes, you can write custom MDX explanations for Medusa API endpoints. The Skill supports hand-written content alongside auto-generated OpenAPI specs to detail authentication, common patterns, and custom explanations.

Does this approach support adding JS SDK and cURL examples to developer docs?

Yes, generating developer docs with this Skill supports adding JS SDK and cURL examples. It integrates multi-language code examples directly into the MDX files to provide comprehensive API usage guidance.

What is the best way to document authentication and pagination for the Medusa Store API?

The best way to document authentication and pagination for the Medusa Store API is by updating the relevant MDX files with hand-written content. This Skill focuses specifically on detailing these parameters and custom explanations.

Do I need OpenAPI specifications to document Medusa client libraries?

Yes, you need OpenAPI specifications to document Medusa client libraries. The Skill leverages these specifications to auto-generate the foundational route documentation before adding manual MDX content and examples.