- 查找报告并修复某个 bug 的 issue 或 pull request
- 阅读 README 或文档页面中能够回答某个具体问题的相关段落
- 追溯 API 契约至修改它的 pull request
- 找出错误消息背后的讨论
端点
搜索开发者索引
POST;当你需要以 JSON 传递数组筛选条件时,这种形式更方便:
cURL
id,例如 issue:owner/repo#123,以及 type (doc、issue、pull_request 或 readme) 、url 和 Markdown 格式的匹配 passages,从而保留表格和代码块。doc 结果通常没有 title,因为源页面可能没有可用标题;因此应回退到 url,不要假定该字段一定存在。
除结果外,coverage 会报告每种结果类型的状态,reranked 则表明排序列表是否经过重排序阶段。如果缺少预期的结果类型,请检查 coverage:skipped 表示 types 值未请求该类型,而 degraded 或 unavailable 表示缺失是由索引或筛选条件造成的,而非查询。
可选筛选条件可缩小搜索范围:
k设置返回结果数量,默认值为 10;passages设置每个结果包含的匹配段落数量types选择要搜索的doc、issue、pull_request和readme类型repos限定索引中 GitHub 部分的搜索范围,sources限定文档部分的搜索范围- 将
skills设为only可将搜索限制为已建立索引的代理技能文件 language、topic、license、min_stars、max_stars、archived和fork按仓库属性筛选,例如language=Rust、topic=async或license=MIT
sources 范围的情况下发送其中任一筛选条件,不会返回 doc 结果,并会在 coverage 中将 doc 标记为 unavailable。发送前请阅读仓库筛选条件如何限定搜索范围。
请参见开发者搜索参考,了解各筛选条件的类型和取值范围、repos 和 sources 如何限定搜索范围,以及完整的响应 schema。
在网页搜索中添加开发者结果
/search,并希望在单次调用中同时权衡开发者结果和普通网页结果,请在 /search 的 categories 数组中传入 developer。API 会在 web 旁以 developer 分组返回这些结果,两个 SDK 也都将该分组暴露为 .developer。
无需 API 密钥即可开始使用 — /search 接受免密钥请求,并包含 developer 类别,但受免密钥额度限制。如需更高的限流,请提供 API 密钥。
url、title、description 和 position,结构与网页结果相同,并额外包含 category: "developer"。同一响应中的网页结果不含 category,因此如果合并两个分组,可通过该字段进行区分。结果会单独分组,而不包含在 web 中,因此 SDK 用户应通过 result.developer 获取。
此功能返回的是网页结果结构,而非经过排序的开发者结果结构。如需匹配段落和索引筛选条件,请使用开发者搜索端点。
托管的 MCP server 同时提供这两种功能,且两者均不会写入任何内容。请参见 MCP tools,了解
firecrawl_developer_search、如何通过 firecrawl_search 获取开发者结果,以及两者中哪个可通过免密钥工具集使用。
