-
Notifications
You must be signed in to change notification settings - Fork 95
Add developer-index and research-index session skills #201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| name: firecrawl-developer-index | ||
| description: | | ||
| Search issues, merged pull requests, READMEs, and documentation. Use when the question is how a library or API behaves, what an error means, or whether a bug was fixed; prefer this over a general web page. | ||
| allowed-tools: | ||
| - Bash(firecrawl *) | ||
| - Bash(npx firecrawl-cli *) | ||
| --- | ||
|
|
||
| # firecrawl developer | ||
|
|
||
| Answer a developer question from the primary source: the issue, the merged pull request that fixed it, or the README/docs passage that states the contract. | ||
|
|
||
| ## Quick start | ||
|
|
||
| ```bash | ||
| mkdir -p .firecrawl | ||
| firecrawl developer "how do I configure retries" --limit 10 -o .firecrawl/developer.json --json | ||
| jq -r '.results[] | .id, .url, .passages[].text' .firecrawl/developer.json | ||
| ``` | ||
|
|
||
| Run `firecrawl developer --help` for the full option list. | ||
|
|
||
| HTTP: `GET|POST https://api.firecrawl.dev/v2/search/developer`. MCP: `firecrawl_developer_search`. Each hit carries `id`, `url`, `passages`. Kind is the `id` prefix (`doc:`, `issue:`, `pull_request:`, `readme:`). Hits do not carry a `type` field. | ||
|
|
||
| **Done when:** the answer quotes a matched passage and cites its `url` (fall back to `url` when `title` is absent), or you have moved to the open web because the index had nothing to say. | ||
|
|
||
| ## Tips | ||
|
|
||
| - Default first move is `firecrawl developer`. Use `search --categories developer` only when you are already running a web search and want developer hits in the same call (no passage control, no index filters). | ||
| - Literal error or stack trace: search the string plus the library name. On HTTP, `types=["issue","pull_request"]`. Strip paths, line numbers, and ids, then retry. | ||
| - API contract: `readme` and `doc` are authoritative. A merged PR supersedes an issue report. Never answer from an opening report alone. | ||
| - Scope last: search the whole index, then narrow with HTTP `types`, `repos`, or `sources`. If a scoped search is empty, read the echoed `indexed` flag before concluding the repo is missing. | ||
| - Repository filters (`language`, `topic`, `license`, `min_stars`, …) drop `doc` results unless you also pass `sources`. `types`, `repos`, `sources`, `passages`, and those repository filters are HTTP-only. | ||
| - Comparison, opinion, news, or an unindexed project: `firecrawl search`, then `firecrawl scrape`. | ||
|
|
||
| ## See also | ||
|
|
||
| - [firecrawl-search](../firecrawl-search/SKILL.md) — open web, or `search --categories developer` in the same call | ||
| - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — full page when a hit is right but you need all of it | ||
| - [firecrawl-research-index](../firecrawl-research-index/SKILL.md) — papers, not this index | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| name: firecrawl-research-index | ||
| description: | | ||
| Find papers in Firecrawl's research paper index (PubMed, bioRxiv, medRxiv, arXiv). Use for literature-finding of any kind, including clinical and biomedical questions; `search --categories research` is a website filter, not this index. | ||
| allowed-tools: | ||
| - Bash(firecrawl *) | ||
| - Bash(npx firecrawl-cli *) | ||
| --- | ||
|
|
||
| # firecrawl research | ||
|
|
||
| Find the papers that answer a research query. When in doubt, return the relevant set (most relevant first) rather than one hit. | ||
|
|
||
| ## Quick start | ||
|
|
||
| ```bash | ||
| mkdir -p .firecrawl | ||
| firecrawl research search-papers "CRISPR base editing off-target effects" \ | ||
| --limit 20 -o .firecrawl/papers.json --json | ||
| jq -r '.results[] | .primaryId, .title' .firecrawl/papers.json | ||
| ``` | ||
|
|
||
| Run `firecrawl research <subcommand> --help` for flags. MCP arguments use `paperId`, not `id`. | ||
|
|
||
| A successful `search-papers` response is `{success, results}`. Each hit carries `paperId`, `primaryId` (`pmid:`, `pmcid:`, `doi:`, or `arxiv:`), `ids`, `title`, `abstract`, and `score`. | ||
|
|
||
| **Done when:** the answer is a cited paper set (or the one named paper), each kept or dropped against a verified constraint, with `search-papers` as the first move unless the query already named an id. | ||
|
|
||
| ## Tips | ||
|
|
||
| - `search-papers` is the first move. If results look thin or all-alike, re-run with a different framing (sibling domain, rival method, dataset/benchmark name). | ||
| - `related-papers` needs `--intent`. `mode=similar` for siblings, `citers` for who builds on the seeds, `references` for what they build on. | ||
| - `inspect-paper` is metadata for one id. `read-paper` is in-body passages for one constraint (sample size, method, affiliation). Use it to rule a paper out, not to gatekeep. | ||
| - `search --categories research` is a website filter. It returns pages from academic domains, not paper records in this index. | ||
| - Named paper ("the Qwen3 report") → one `search-papers`. Method / family / "papers that do X" → expand with `related-papers` and keep neighbors. | ||
| - Superlative / leaderboard questions live on the web: `firecrawl search` / `firecrawl scrape`, then `search-papers` each top entry. | ||
| - PubMed, bioRxiv, and medRxiv are the largest part of the corpus. Do not send a biomedical query to the open web on the assumption the index is arXiv-only. | ||
|
|
||
| ## See also | ||
|
|
||
| - [firecrawl-search](../firecrawl-search/SKILL.md) — web pages, including `search --categories research` | ||
| - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — leaderboards and other non-paper pages | ||
| - [firecrawl-developer-index](../firecrawl-developer-index/SKILL.md) — issues, PRs, READMEs, and docs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.