Skip to content
TrustedSkillsbeta
Back to all skills

Api Style Guide

Checked
gtmagents·vlatest·writing·Apache-2.0

Provides API guidance and assistance for agent 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 gtmagents/gtm-agents --skill api-style-guide -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

gtmagents

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 gtmagents/gtm-agents at 78e0419f44.

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

Commit
78e0419f44
Manifest
plugins/technical-writing/skills/api-style-guide/SKILL.md
Scanned
1 file, 31 lines
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 provides guidance on writing effective API style guides. It helps ensure consistency and clarity in documentation, making APIs easier to understand and use. The skill can generate structured outlines, suggest formatting conventions, and offer examples of clear and concise explanations for API endpoints.

When to use it

  • Creating new API documentation: Use this skill when you're starting from scratch and need a framework for your API style guide.
  • Standardizing existing documentation: If your API documentation is inconsistent, this skill can help establish and enforce standards.
  • Onboarding new developers: A well-written API style guide created with this skill will simplify the onboarding process for new team members.
  • Improving developer experience: Clear and consistent API documentation leads to a better overall developer experience and reduces frustration.

Key capabilities

  • Generates structured outlines for API style guides.
  • Suggests formatting conventions (e.g., headers, code blocks).
  • Provides examples of clear and concise explanations.

Example prompts

  • "Create an outline for an API style guide covering authentication methods."
  • "Suggest formatting guidelines for documenting request parameters in an API reference."
  • "Give me an example of how to describe a successful API response code 200."

Tips & gotchas

This skill is most effective when provided with context about the specific APIs being documented. The more information you give it about your existing conventions, the better the generated style guide will be.