mcpField
R
runpod-usage

runpod-usage

github.com/runpodCloud & DevOps4712.8k installsUpdated 2d ago
Repository

About runpod-usage

A reference skill for understanding Runpod concepts before choosing an infrastructure action. It directs readers to focused guides and concept files, while leaving execution to tools such as runpod-mcp, runpodctl, flash, or companion-clis.

Key features

  1. 01Runpod infrastructure concepts
  2. 02Focused guides by question
  3. 03YAML concept and rule references
  4. 04Links to verified end-to-end examples

Use cases

  1. 01Compare Pods and serverless options
  2. 02Choose GPU and estimate requirements
  3. 03Understand storage and model caching
  4. 04Check rules before an infrastructure change

MCP support

The skill does not execute actions; it points to runpod-mcp and runpodctl for infrastructure operations.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/runpod/runpod-plugins-official --skill runpod-usage

After installing, type/runpod-usagein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

concepts/
api-key.yaml
api-rate-limit.yaml
billing-record.yaml
cloud-tier.yaml
container-disk.yaml
container-image.yaml
cpu-flavor.yaml
cpu-pod.yaml
credit-balance.yaml
data-center.yaml
endpoint-autoscaling.yaml
endpoint-build.yaml
endpoint-release.yaml
exposed-port.yaml
file-transfer.yaml
flash.yaml
flashboot.yaml
global-networking.yaml
gpu-availability.yaml
gpu-pool.yaml
gpu-type.yaml
hub-repo.yaml
instant-cluster.yaml
job.yaml
log-stream.yaml
machine.yaml
model-store.yaml
network-volume-billing.yaml
network-volume.yaml
pod-billing.yaml

Details

From the project README

Runpod usage (concepts)

Background knowledge for making the right choice before you act. This skill runs nothing — once you know what to do, execute with runpod-mcp/runpodctl (infra), flash (your own code), or companion-clis (models/images/data).

This skill explains; the golden paths demonstrate. When the question is really "how do I do X" rather than "how does X work", the verified end-to-end example is the faster answer — runpod/golden-paths/README.md. Read the concept here, then follow the path.

To author files for a custom template, use runpod-build-template; this lane supplies the shared concepts, not a competing packaging workflow.

Read the one reference file that matches the question:

QuestionRead
First-run setup / auth — get + set RUNPOD_API_KEY, SSH, companion credsreference/getting-started.md
Pods vs serverless, workers, cold starts, FlashBoot, queue vs load-balancedreference/concepts.md
The development loop for ANY workload (start here) — plan → prefer prebuilt → provision → verify → teardownreference/development-loop.md
Stand up / iterate a workload on a pod — the pod sub-loopreference/pod-workflows.md
Deploy / iterate a serverless endpoint — Hub vs flash vs custom, invoke + verifyreference/endpoint-workflows.md
Install software on a pod — package hygiene, uv, non-interactive, cachingreference/on-pod-setup.md
Build a Docker image Runpod can run (handler contract, Dockerfile, --platform=linux/amd64)reference/docker.md
How to build an image well — base image, layering, bake-in vs volume, pod vs serverless (queue/LB) contractreference/building-images.md
Where data lives — container disk vs network volume, model caching, S3 accessreference/storage.md
Which GPU / how much VRAM / which CUDA version / cost & availability / data centersreference/gpu-selection.md
Why a stopped pod may not restart with a GPU — pods are bound to one machine; what else is per machinereference/pods-and-machines.md
Endpoint releases, rolling updates, version overlap, GitHub buildsreference/endpoint-builds-and-releases.md
Storing API tokens and keys as secrets and referencing them from env varsreference/secrets.md
Reaching a pod or endpoint over HTTP (proxy URLs, exposed ports)reference/networking.md
Common mistakes and how to avoid themreference/gotchas.md

Exact facts: the concept files

The reference files explain. For a precise fact, or a rule an action must satisfy, read the concept files in concepts/ next to this file. There is one YAML file per concept (pod.yaml, network-volume.yaml, machine.yaml, …), each with its fields, states, relations and rules, and every rule cites the public source it comes from.

grep -il "volume disk" concepts/*.yaml    # find the concept by name or alias
grep -n "statement:" concepts/pod-volume-disk.yaml
  • rules[].statement is the fact. see: points at related rules on other concepts.
  • A rule with conflict: true records two public sources that disagree. Give both readings.
  • A kind: process file explains a flow step by step. pod-deployment.yaml covers deploy, stop and restart, including why a restart can fail while the data center has stock.

Comments

Markdown supported