gpt-researcher — скилл для Claude Code: что делает и как установить
Скилл помогает дорабатывать и отлаживать GPT Researcher: писать новые ретриверы, подключать источники MCP и настраивать пайплайны отчётов.
Apache-2.0 1 установок ★ 30 819 обновлён 2026-10-10
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a claude-codeЧто делает gpt-researcher
Описывает кодовую базу GPT Researcher — автономного агента для сбора информации в сети и локальных файлах по схеме «планировщик — исполнитель — издатель». Навык ориентирует модель в структуре проекта, связывая декомпозицию поисковых подзапросов в ResearchConductor с формированием Markdown-документов через ReportGenerator.
Внутри собраны чёткие шаблоны: пошаговый алгоритм добавления фич из восьми этапов, правила создания поисковых классов в gpt_researcher/retrievers/ и передача событий во фронтенд через WebSocket. Также расписано подключение MCP-серверов в параметре mcp_configs с выбором стратегии deep или fast.
Все методы исследования строго асинхронные. Параметры конфига при чтении всегда переводятся в нижний регистр вроде self.cfg.smart_llm, поэтому попытка обратиться к переменной в верхнем регистре вызовет ошибку.
Какие задачи решает
- добавить кастомный поисковый ретривер в пайплайн
- подключить внешние источники данных через MCP-серверы
- провести новую фичу по восьми шагам архитектуры проекта
- настроить потоковую передачу логов и статусов через WebSocket
Примеры запросов агенту
- Помоги написать новый ретривер для локальной базы документов в GPT Researcher
- Настрой подключение MCP-сервера GitHub для режима deep research
- Покажи, как добавить провайдер и связать его со скиллами по схеме проекта
Как установить gpt-researcher
1Через Skills CLI (Vercel)
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a claude-code2Вручную: положить файлы
~/.claude/skills/claude/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/claude/
1Через Skills CLI (Vercel)
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a codex2Вручную: положить файлы
.agents/skills/claude/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a cursor2Вручную: положить файлы
.cursor/skills/claude/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install assafelovic/gpt-researcher claude2Вручную: положить файлы
.github/skills/claude/SKILL.md1Через Skills CLI (Vercel)
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a gemini-cli2Командой платформы
gemini skills install https://github.com/assafelovic/gpt-researcher --path .claudeВручную: положить файлы
.devin/skills/claude/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add assafelovic/gpt-researcher --skill gpt-researcher -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о gpt-researcher
Как установить gpt-researcher в Claude Code?
Выполните в терминале npx skills add assafelovic/gpt-researcher --skill claude -a claude-code. Навык сохранится в ~/.claude/skills/claude/SKILL.md.
Зачем нужен скилл gpt-researcher?
Он даёт ИИ-ассистенту контекст архитектуры репозитория, правила регистрации компонентов и готовые примеры кода для расширения движка исследований.
Как в коде GPT Researcher обращаться к настройкам?
Все ключи конфига читаются в нижнем регистре, например config.my_var. Приоритет отдаётся переменным окружения, затем JSON-файлу и только потом значениям по умолчанию.
Исходный текст
SKILL.md · Apache-2.0
---
name: gpt-researcher
description: GPT Researcher is an autonomous deep research agent that conducts web and local research, producing detailed reports with citations. Use this skill when helping developers understand, extend, debug, or integrate with GPT Researcher - including adding features, understanding the architecture, working with the API, customizing research workflows, adding new retrievers, integrating MCP data sources, or troubleshooting research pipelines.
---
# GPT Researcher Development Skill
GPT Researcher is an LLM-based autonomous agent using a planner-executor-publisher pattern with parallelized agent work for speed and reliability.
## Quick Start
### Basic Python Usage
```python
from gpt_researcher import GPTResearcher
import asyncio
async def main():
researcher = GPTResearcher(
query="What are the latest AI developments?",
report_type="research_report", # or detailed_report, deep, outline_report
report_source="web", # or local, hybrid
)
await researcher.conduct_research()
report = await researcher.write_report()
print(report)
asyncio.run(main())
```
### Run Servers
```bash
# Backend
python -m uvicorn backend.server.server:app --reload --port 8000
# Frontend
cd frontend/nextjs && npm install && npm run dev
```
---
## Key File Locations
| Need | Primary File | Key Classes |
|------|--------------|-------------|
| Main orchestrator | `gpt_researcher/agent.py` | `GPTResearcher` |
| Research logic | `gpt_researcher/skills/researcher.py` | `ResearchConductor` |
| Report writing | `gpt_researcher/skills/writer.py` | `ReportGenerator` |
| All prompts | `gpt_researcher/prompts.py` | `PromptFamily` |
| Configuration | `gpt_researcher/config/config.py` | `Config` |
| Config defaults | `gpt_researcher/config/variables/default.py` | `DEFAULT_CONFIG` |
| API server | `backend/server/app.py` | FastAPI `app` |
| Search engines | `gpt_researcher/retrievers/` | Various retrievers |
---
## Architecture Overview
```
User Query → GPTResearcher.__init__()
│
▼
choose_agent() → (agent_type, role_prompt)
│
▼
ResearchConductor.conduct_research()
├── plan_research() → sub_queries
├── For each sub_query:
│ └── _process_sub_query() → context
└── Aggregate contexts
│
▼
[Optional] ImageGenerator.plan_and_generate_images()
│
▼
ReportGenerator.write_report() → Markdown report
```
**For detailed architecture diagrams**: See [references/architecture.md](references/architecture.md)
---
## Core Patterns
### Adding a New Feature (8-Step Pattern)
1. **Config** → Add to `gpt_researcher/config/variables/default.py`
2. **Provider** → Create in `gpt_researcher/llm_provider/my_feature/`
3. **Skill** → Create in `gpt_researcher/skills/my_feature.py`
4. **Agent** → Integrate in `gpt_researcher/agent.py`
5. **Prompts** → Update `gpt_researcher/prompts.py`
6. **WebSocket** → Events via `stream_output()`
7. **Frontend** → Handle events in `useWebSocket.ts`
8. **Docs** → Create `docs/docs/gpt-researcher/gptr/my_feature.md`
**For complete feature addition guide with Image Generation case study**: See [references/adding-features.md](references/adding-features.md)
### Adding a New Retriever
```python
# 1. Create: gpt_researcher/retrievers/my_retriever/my_retriever.py
class MyRetriever:
def __init__(self, query: str, headers: dict = None):
self.query = query
async def search(self, max_results: int = 10) -> list[dict]:
# Return: [{"title": str, "href": str, "body": str}]
pass
# 2. Register in gpt_researcher/actions/retriever.py
case "my_retriever":
from gpt_researcher.retrievers.my_retriever import MyRetriever
return MyRetriever
# 3. Export in gpt_researcher/retrievers/__init__.py
```
**For complete retriever documentation**: See [references/retrievers.md](references/retrievers.md)
---
## Configuration
Config keys are **lowercased** when accessed:
```python
# In default.py: "SMART_LLM": "gpt-4o"
# Access as: self.cfg.smart_llm # lowercase!
```
Priority: Environment Variables → JSON Config File → Default Values
**For complete configuration reference**: See [references/config-reference.md](references/config-reference.md)
---
## Common Integration Points
### WebSocket Streaming
```python
class WebSocketHandler:
async def send_json(self, data):
print(f"[{data['type']}] {data.get('output', '')}")
researcher = GPTResearcher(query="...", websocket=WebSocketHandler())
```
### MCP Data Sources
```python
researcher = GPTResearcher(
query="Open source AI projects",
mcp_configs=[{
"name": "github",
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {"GITHUB_TOKEN": os.getenv("GITHUB_TOKEN")}
}],
mcp_strategy="deep", # or "fast", "disabled"
)
```
**For MCP integration details**: See [references/mcp.md](references/mcp.md)
### Deep Research Mode
```python
researcher = GPTResearcher(
query="Comprehensive analysis of quantum computing",
report_type="deep", # Triggers recursive tree-like exploration
)
```
**For deep research configuration**: See [references/deep-research.md](references/deep-research.md)
---
## Error Handling
Always use graceful degradation in skills:
```python
async def execute(self, ...):
if not self.is_enabled():
return [] # Don't crash
try:
result = await self.provider.execute(...)
return result
except Exception as e:
await stream_output("logs", "error", f"⚠️ {e}", self.websocket)
return [] # Graceful degradation
```
---
## Critical Gotchas
| ❌ Mistake | ✅ Correct |
|-----------|-----------|
| `config.MY_VAR` | `config.my_var` (lowercased) |
| Editing pip-installed package | `pip install -e .` |
| Forgetting async/await | All research methods are async |
| `websocket.send_json()` on None | Check `if websocket:` first |
| Not registering retriever | Add to `retriever.py` match statement |
---
## Reference Documentation
| Topic | File |
|-------|------|
| System architecture & diagrams | [references/architecture.md](references/architecture.md) |
| Core components & signatures | [references/components.md](references/components.md) |
| Research flow & data flow | [references/flows.md](references/flows.md) |
| Prompt system | [references/prompts.md](references/prompts.md) |
| Retriever system | [references/retrievers.md](references/retrievers.md) |
| MCP integration | [references/mcp.md](references/mcp.md) |
| Deep research mode | [references/deep-research.md](references/deep-research.md) |
| Multi-agent system | [references/multi-agents.md](references/multi-agents.md) |
| Adding features guide | [references/adding-features.md](references/adding-features.md) |
| Advanced patterns | [references/advanced-patterns.md](references/advanced-patterns.md) |
| REST & WebSocket API | [references/api-reference.md](references/api-reference.md) |
| Configuration variables | [references/config-reference.md](references/config-reference.md) |
© assafelovic · Apache-2.0 · assafelovic/gpt-researcher