How do I install the API Sparse Fieldsets Partial Responses skill?

Run npx skillmds@latest add deangrant/api-sparse-fieldsets-partial-responses in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is API Sparse Fieldsets Partial Responses safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Sparse Fieldsets Partial Responses?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Sparse Fieldsets Partial Responses free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Sparse Fieldsets Partial Responses?

deangrant (@deangrant) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Sparse Fieldsets Partial Responses by deangrant

Name: API Sparse Fieldsets Partial Responses
Author: deangrant

API Sparse Fieldsets Partial Responses

Design sparse fieldsets and include/expand for REST APIs: allowlisted ?fields=, relationship includes with depth caps, complete defaults. Use when reducing over-fetching, designing GraphQL-like shaping on REST, or reviewing list payload size.

deangrant 67e6afd 4 files · 2.5 KB Updated Sep 17, 2026

File contents

Sparse Fieldsets and Partial Responses

Use this skill when clients need to select fields or embed related resources without abandoning REST. Defaults stay complete and predictable; shaping is opt-in.

1. Sparse fieldsets

GET /users/7?fields=id,name,email

Whitelist selectable fields; always include id.
Reject or explicitly ignore unknown fields — do not silently expose internals.
JSON:API: ?fields[articles]=title&fields[people]=name.

2. Include / expand

GET /orders/42?include=customer,items

Without include, return IDs/links. Cap depth (1–2), whitelist relationships, limit count/bytes. Keep list-endpoint includes shallow; rate-limit heavy expand.

3. Caching

Cache keys / Vary must account for fields and include variance.

4. Quick checklist

Complete default responses.
Allowlisted fields; always id.
Allowlisted include with depth/count caps.
Document params in OpenAPI.
Shallow expands on collections.
Cache variance documented.

See reference.md and examples.md.

Frequently asked questions