Skip to content
TrustedSkillsbeta
Back to all skills

Api Design

Checked
s-hiraoku·vlatest·backend

Helps with API, design as part of developing backend services and APIs workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add s-hiraoku/synapse-a2a --skill api-design -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

s-hiraoku

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned s-hiraoku/synapse-a2a at 844eb75d92.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
844eb75d92
Manifest
.agents/skills/api-design/SKILL.md
Scanned
3 files, 417 lines
Copies in repo
3 — all of them scanned
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill enables AI agents to design and generate API specifications, allowing them to define endpoints, request/response schemas, and authentication methods programmatically. It streamlines the backend development workflow by automating the creation of structured interface documentation.

When to use it

  • You need to rapidly prototype a new service interface without manually writing OpenAPI or Swagger definitions.
  • Your team requires consistent API documentation that stays synchronized with code changes.
  • You are building an agent that must understand existing REST or GraphQL structures to integrate with legacy systems.
  • You want to generate boilerplate code for API clients based on defined specifications.

Key capabilities

  • Generates comprehensive API documentation in standard formats like OpenAPI (Swagger).
  • Defines endpoint routes, HTTP methods, and status codes automatically.
  • Creates detailed request and response payload schemas.
  • Supports configuration of authentication mechanisms and rate limiting rules.

Example prompts

  • "Design a REST API for a user management system with endpoints for registration, login, and profile updates."
  • "Generate an OpenAPI specification for a payment processing service that accepts credit card details securely."
  • "Create API documentation for a GraphQL schema that queries inventory levels across multiple warehouses."

Tips & gotchas

Ensure your agent has access to the necessary context about business logic or data models before requesting API designs, as vague inputs may result in generic specifications. This skill is best used during the planning phase of backend development rather than for runtime execution.