Agent skill

Docs Researcher

by shopsys in shopsys/shopsys

Searches and analyzes documentation to provide relevant information for development tasks.

Custom licenceAuto-check passedBackend & APIs

Install Docs Researcher

skills CLI
$ npx skills add shopsys/shopsys --skill docs-researcher -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install shopsys/shopsys docs-researcher --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/shopsys/shopsys.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-researcher .claude/skills/docs-researcher && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-researcher
GitHub stars
350
Token cost
~1.5k tokens
SKILL.md length
501 words
Files
1
Skills in repo
38
Repo updated
First seen
Licence
Custom licence

At a glance

Searches and analyzes documentation to provide relevant information for development tasks.

  • Works in 3 steps: Understand the Query Context → Strategic Documentation Search → Deep Dive and Cross-Reference
  • Backend & APIs work in your project
  • SKILL.md covers Core Responsibilities, Documentation Structure…, Primary Documentation Areas and Research Strategy, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Docs Researcher is an agent skill from shopsys/shopsys. Searches and analyzes documentation to provide relevant information for development tasks. Use this agent when you need documentation context, architectural guidance, or implementation examples from the docs/ folder.

Its SKILL.md is about 1.5k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs. It works with GraphQL. The repository describes itself as: Main repository for maintaining Shopsys Platform packages. Open for ISSUES and PULL REQUESTS.

When your agent uses it

  • Backend & APIs work in your project

Example prompts

  • “Use the docs-researcher skill to search and analyzes documentation to provide relevant information for development tasks”
  • “/docs-researcher”

Requirements

  • Docker

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Understand the Query Context
  2. Strategic Documentation Search
  3. Deep Dive and Cross-Reference

What it can do on your machine

Read from SKILL.md and the folder at commit 0514b92. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Researcher loads about 1.5k tokens when it runs. Until then it costs about 58 tokens; SKILL.md has 501 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~58
When it runs · the whole SKILL.md, loaded when a task matches
~1.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 501 words (~1,501 tokens).

“You are a documentation specialist focused on finding and analyzing relevant information from the Shopsys Platform documentation. Your job is to quickly locate, read, and synthesize documentation to support development tasks.”

— opening of SKILL.md by shopsys, Custom licence
name
docs-researcher
tools
Read, Grep, Glob, LS

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/docs-researcher of shopsys/shopsys.

Open the folder on GitHubat commit 0514b92

Compare with similar skills

Docs Researcher next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Researcher compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Researcher this skillshopsys/shopsys350—~1.5kAutomated safety check: PassCustom licence
Nodejs Backend Patternsever-works/ever-works16218 repos~4kAutomated safety check: PassAGPL-3.0
Use Yaakmountain-loop/yaak19k—~1.9kAutomated safety check: PassMIT
API DesignerJeffallan/claude-skills12k1 repos~2kAutomated safety check: PassMIT
GraphQL Operations with CodegenChrisWiles/claude-code-showcase6.1k3 repos~1.5kAutomated safety check: PassNone
Nestjs Trpctrycompai/crm11k—~2.8kAutomated safety check: PassMIT

Similar skills

  • Nodejs Backend Patterns

    ever-works/ever-works

    Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.

    162 GitHub starsUsed in 18 repos~4k tokens
    Backend & APIsAuto-check passed
  • Use Yaak

    mountain-loop/yaak

    A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…

    19k GitHub stars~1.9k tokensUpdated 2 days ago
    Backend & APIsAuto-check passed
  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 1 repo~2k tokens
    Backend & APIsAuto-check passed
  • GraphQL Operations with Codegen

    ChrisWiles/claude-code-showcase

    Sets the rules for writing GraphQL queries and mutations in .gql files, running codegen, and using generated Apollo hooks with proper error and loading handling.

    6.1k GitHub starsUsed in 3 repos~1.5k tokens
    Backend & APIsAuto-check passed
  • Nestjs Trpc

    trycompai/crm

    Build end-to-end type-safe tRPC APIs inside NestJS using the nestjs-trpc adapter — @Router/@Query/@Mutation/@Subscription decorators, TRPCModule.forRoot, injectable middlewares and context, Zod…

    11k GitHub stars~2.8k tokensUpdated 28 days ago
    Backend & APIsAuto-check passed
  • API Design Principles

    jh941213/my-cc-harness

    REST 및 GraphQL API 설계 원칙 가이드. An agent skill from jh941213/my-cc-harness.

    126 GitHub starsUsed in 18 repos~3.4k tokens
    Backend & APIsAuto-check passed

More from shopsys/shopsys

All 38 skills in this repo
  • Adhoc PR

    shopsys/shopsys

    Ad-hoc Pull Request Publisher — commits the current changes, pushes the branch, opens a GitHub pull request against the repository's default branch, and creates a matching SSP Jira issue in the…

    350 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Commit

    shopsys/shopsys

    Interactive commit workflow — analyzes all uncommitted changes, proposes atomic, logically grouped commits with messages following commit-conventions, and executes them only after the user approves…

    350 GitHub stars~771 tokensUpdated today
    Auto-check: notes
  • Create Enum

    shopsys/shopsys

    Create a Shopsys-style enum (a class extending AbstractEnum with public typed constants, NOT a native PHP enum).

    350 GitHub stars~1.9k tokensUpdated today
    Auto-check passed
  • PR Comments

    shopsys/shopsys

    Work with GitHub PR review threads — list unresolved comments as a digest (who is waiting on whom), reply to threads, and resolve/unresolve them.

    350 GitHub stars~2k tokensUpdated today
    Auto-check passed
  • PR Description

    shopsys/shopsys

    Generates a PR description focused on business value using the project's PR template.

    350 GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Rebase Autosquash

    shopsys/shopsys

    Rebase a branch onto the latest base branch and apply its fixup commits (git rebase --autosquash), resolving conflicts semantically along the way.

    350 GitHub stars~1.2k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Docs Researcher

What does Docs Researcher do?

Searches and analyzes documentation to provide relevant information for development tasks. Docs Researcher is an agent skill from shopsys/shopsys. Searches and analyzes documentation to provide relevant information for development tasks.

When should I use Docs Researcher?

Docs Researcher fits situations like: backend & APIs work in your project.

How do I install Docs Researcher in Claude Code?

Run `npx skills add shopsys/shopsys --skill docs-researcher -a claude-code`. Or copy the skill folder (.agents/skills/docs-researcher in shopsys/shopsys) into .claude/skills/docs-researcher in your project. Claude Code loads it when a task matches its description.

How do I install Docs Researcher in Codex?

Run `npx skills add shopsys/shopsys --skill docs-researcher -a codex`. Or copy the skill folder (.agents/skills/docs-researcher in shopsys/shopsys) into .agents/skills/docs-researcher in your project. Codex loads it when a task matches its description.

Can I use Docs Researcher in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add shopsys/shopsys --skill docs-researcher -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-researcher, .gemini/skills/docs-researcher, .github/skills/docs-researcher and .opencode/skills/docs-researcher in your project.

What does Docs Researcher need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Researcher is instructions for the agent only. Our summary lists: Docker.

Does Docs Researcher access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Researcher safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Researcher use?

Docs Researcher has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Docs Researcher use?

About 1.5k tokens (SKILL.md is roughly 6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Researcher?

Skills that share tags, products or a category with Docs Researcher: Nodejs Backend Patterns (ever-works/ever-works, 162 stars), Use Yaak (mountain-loop/yaak, 19k stars), API Designer (Jeffallan/claude-skills, 12k stars) and GraphQL Operations with Codegen (ChrisWiles/claude-code-showcase, 6.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Researcher?

shopsys (a GitHub organization) maintains it in shopsys/shopsys, which has 350 GitHub stars. The repository holds 38 skills in this directory. The repository was last updated on October 9, 2026.

Source: shopsys/shopsys on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.