Skip to main content
skill CX Codex

search-docs — Claude Code skill: what it does, how to install

Prepares search queries and directs agents to the right ImageKit documentation sources before running the search_docs tool.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add imagekit-developer/skills --skill search-docs -a claude-code
Open on GitHub

What search-docs does

This skill guides coding assistants when looking up ImageKit features, SDK usage, and pricing. Before calling the search_docs tool, the agent rewrites vague user prompts into precise queries. A brief question like "How do I upload?" becomes a query targeted at the ImageKit upload API.

The instructions also guide source filtering. The agent defaults to imagekit_guides and imagekit_community. For code snippets and technical parameters, it pulls from imagekit_sdk or imagekit_api_references. Every answer includes Markdown references with source URLs.

Keep in mind that this skill only structures the query logic: without an active search_docs tool configured in your environment, the lookup step cannot run.

What it helps with

  • rewrite vague user questions into targeted ImageKit queries
  • locate ImageKit SDK examples and API reference endpoints
  • find parameter limits for media transformation workflows
  • format source reference links from guides and community articles

Example prompts for the agent

  • How do I apply background removal using ImageKit AI transformations?
  • Find SDK examples for uploading files with ImageKit.
  • Check ImageKit pricing tiers and extension unit limits.

How to install search-docs

1Skills CLI (Vercel)

npx skills add imagekit-developer/skills --skill search-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/search-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/search-docs/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about search-docs

How to install search-docs in Claude Code?

Run npx skills add imagekit-developer/skills --skill search-docs -a claude-code in your terminal.

What does search-docs do?

It tells the agent how to turn brief user questions into detailed search queries, pick the right ImageKit documentation sources, and format links in the final answer.

Which documentation sources does this skill use?

It configures four sources: imagekit_guides, imagekit_community, imagekit_api_references, and imagekit_sdk. By default, it queries guides and community discussions.

Source text

SKILL.md · MIT
---
name: search-docs
description: "Guidance for searching ImageKit documentation with the search_docs tool — how to craft effective queries, select the right sources, and handle results. Use before calling search_docs to look up ImageKit features, APIs, configuration, pricing, or SDK examples."
---

# Documentation Search Skill

Prepare your query and source selection using the guidelines below, then call `search_docs` and present the results following the rules here.

## When to use
- User asks about ImageKit features, capabilities, or services
- Transformation builder fails and you need parameter/limit info
- User asks about APIs, configuration, pricing, or DAM features
- Need to verify if ImageKit supports a specific feature
- Need to find SDK usage examples or API reference details

## Tool Parameters

**Required**: `query` - Clear, specific question about ImageKit (see Query Crafting below)

**Optional**: `sources` array (default: `["imagekit_guides", "imagekit_community"]`)
- `imagekit_guides`: Official guides and tutorials
- `imagekit_community`: User-generated content, practical solutions. Great for troubleshooting and real-world use cases.
- `imagekit_api_references`: Technical API details
- `imagekit_sdk`: SDK implementation examples

## Query Crafting

**Rule: Always rewrite vague user questions into specific, searchable queries before calling the tool.**

| User Says | Bad Query (don't pass this) | Good Query |
|---|---|---|
| "Tell me about ImageKit" | "tell me about ImageKit" | "ImageKit features overview image optimization CDN" |
| "How do I upload?" | "upload" | "How to upload files using ImageKit upload API" |
| "Pricing info" | "pricing" | "ImageKit pricing plans and extension unit costs" |
| "Can it do background removal?" | "background removal" | "How to apply background removal using ImageKit AI transformation" |

## Source Selection

| Use Case | Sources |
|----------|---------|
| General features | `["imagekit_guides", "imagekit_community"]` |
| API details | `["imagekit_guides", "imagekit_api_references"]` |
| SDK examples | `["imagekit_sdk", "imagekit_guides", "imagekit_community"]` |
| Troubleshooting | `["imagekit_community", "imagekit_guides"]` |

## Imagekit Community 
- Valuable for real-world solutions, troubleshooting, and user experiences
- May contain practical tips not found in official guides
- Always include community sources. They often provide insights and solutions that official documentation may not cover, especially for troubleshooting and real-world use cases.

## Handling Results

Always cite sources:
```
References:
1. [Title]: [URL]
```

If results don't answer the question, acknowledge the limitation and suggest contacting ImageKit support.

## Gotchas

- Specific queries yield better results ("How to apply background removal using API" not "tell me about ImageKit")
- Multiple searches may be needed; refine query if first search is insufficient
- Community sources provide real-world solutions; official guides are authoritative

© imagekit-developer · MIT · imagekit-developer/skills

Similar skills

All skills for Writing and docs →

From the same set4

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor