Use when investigating external APIs, libraries, and services. Creates standardized API documentation with auth and endpoints. Trigger with API research or library investigation requests.
How this skill is triggered — by the user, by Claude, or both
Slash command
/emasoft-architect-agent:eaa-api-researchThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Comprehensive API research and documentation skill for the API Researcher Agent. This skill provides structured workflows for investigating external APIs, libraries, and services, producing standardized documentation that includes overviews, authentication guides, endpoint references, and integration instructions.
README.mdreferences/collaboration-patterns.mdreferences/op-create-api-overview.mdreferences/op-create-auth-guide.mdreferences/op-create-config-template.mdreferences/op-create-endpoints-ref.mdreferences/op-create-integration-guide.mdreferences/op-research-cloud-service.mdreferences/op-research-graphql-api.mdreferences/op-research-python-library.mdreferences/op-research-rest-api.mdreferences/output-templates.mdreferences/research-procedure.mdreferences/research-scenarios.mdreferences/tools-reference.mdComprehensive API research and documentation skill for the API Researcher Agent. This skill provides structured workflows for investigating external APIs, libraries, and services, producing standardized documentation that includes overviews, authentication guides, endpoint references, and integration instructions.
Copy this checklist and track your progress:
[RESEARCH STARTED] <library> API - <scope>[DONE] <library> API research complete| Output Type | Description |
|---|---|
| API Overview Document | High-level API description with key features and capabilities |
| Authentication Guide | Auth setup, security requirements, and credential management |
| Endpoints Reference | Comprehensive endpoint documentation with parameters and examples |
| Integration Guide | Step-by-step integration instructions with code samples |
| Configuration Template | Configuration options and environment setup |
For the step-by-step research workflow, see research-procedure.md:
For all documentation templates, see output-templates.md:
For available tools and usage, see tools-reference.md:
For common research patterns, see research-scenarios.md:
For interaction with other agents, see collaboration-patterns.md:
| File | Template | Purpose |
|---|---|---|
<library>-api-overview.md | output-templates.md | High-level API description |
<library>-authentication.md | output-templates.md | Auth setup and security |
<library>-endpoints.md | output-templates.md | Endpoint reference |
<library>-integration.md | output-templates.md | Integration guide |
<library>-config-template.md | output-templates.md | Configuration options |
| Step | Action | Verification |
|---|---|---|
| 1 | Understand Requirements | Library name, scope, context clear |
| 2 | Gather Information | Official docs, auth, endpoints, rate limits found |
| 3 | Document Findings | All 5 document types created |
| 4 | Report to Orchestrator | Minimal report with file list sent |
| Situation | Format |
|---|---|
| Start | [RESEARCH STARTED] <library> API - <scope> |
| Progress | [PROGRESS] <library> API - Phase: <phase> |
| Blocked | [BLOCKED] <library> API - Issue: <issue> |
| Complete | [DONE] <library> API research complete |
Orchestrator: Research the Stripe API for payment processing
Agent: [RESEARCH STARTED] Stripe API - payment processing scope
1. Consult official docs at https://stripe.com/docs/api
2. Document authentication (API keys, webhooks)
3. List key endpoints (charges, customers, subscriptions)
4. Create integration guide with code samples
Output files:
- stripe-api-overview.md
- stripe-authentication.md
- stripe-endpoints.md
- stripe-integration.md
- stripe-config-template.md
[DONE] Stripe API research complete
Orchestrator: Research the requests library for HTTP calls
Agent: [RESEARCH STARTED] requests library - HTTP client scope
1. Read PyPI page and official docs
2. Document installation and basic usage
3. List key methods (get, post, put, delete)
4. Create integration examples
[DONE] requests library research complete
| Error | Cause | Solution |
|---|---|---|
| Documentation not found | API has no public docs | Report blocker to orchestrator, suggest alternatives |
| API deprecated | Service is sunset | Document deprecation, find replacement API |
| Multiple versions | API has breaking changes | Document both versions, recommend latest |
| Rate limit hit | Too many doc requests | Wait and retry, use cached versions |
| Authentication unclear | Docs incomplete | Experiment with API, document findings |
npx claudepluginhub emasoft/emasoft-plugins --plugin emasoft-architect-agentSystematically gathers accurate, version-specific documentation before implementing libraries or APIs. Uses structured 5-step methodology for source prioritization, retrieval, verification, and citation.
Guides doc lookup and web search workflow for investigating libraries, APIs, or unfamiliar patterns before implementation.
Generates API documentation from code, covering endpoints, parameters, request/response examples, authentication, error handling, and usage guidelines. Supports REST, GraphQL, and WebSocket APIs.