literature-search

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Literature Search

文献搜索

Search across all major scientific literature databases (PubMed, arXiv, bioRxiv, medRxiv) simultaneously using natural language queries powered by Valyu's semantic search API.
借助Valyu的语义搜索API,使用自然语言查询同时搜索所有主要科学文献数据库(PubMed、arXiv、bioRxiv、medRxiv)。

Why This Skill is Powerful

该工具的强大之处

  • No API Parameter Parsing: Just pass natural language queries directly - no need to construct complex search parameters
  • Semantic Search: Understands the meaning of your query, not just keyword matching
  • Full-Text Access: Returns complete article content, not just abstracts
  • Image Links: Includes figures and images from papers
  • Comprehensive Coverage: Search across PubMed, arXiv, bioRxiv, and medRxiv simultaneously
  • Unified Results: Get results from all sources in a single query
  • 无需解析API参数:直接传入自然语言查询即可,无需构建复杂的搜索参数
  • 语义搜索:理解查询的含义,而非仅进行关键词匹配
  • 全文访问:返回完整的文章内容,而非仅摘要
  • 图片链接:包含论文中的图表和图片
  • 全面覆盖:同时搜索PubMed、arXiv、bioRxiv和medRxiv
  • 统一结果:一次查询获取所有来源的结果

Requirements

环境要求

  1. Node.js 18+ (uses built-in fetch)
  2. Valyu API key from https://platform.valyu.ai ($10 free credits)
  1. Node.js 18及以上版本(使用内置的fetch功能)
  2. https://platform.valyu.ai获取Valyu API密钥(赠送10美元免费额度)

CRITICAL: Script Path Resolution

重要提示:脚本路径解析

The
scripts/search
commands in this documentation are relative to this skill's installation directory.
Before running any command, locate the script using:
bash
LITERATURE_SCRIPT=$(find ~/.claude/plugins/cache -name "search" -path "*/literature-search/*/scripts/*" -type f 2>/dev/null | head -1)
Then use the full path for all commands:
bash
$LITERATURE_SCRIPT "CRISPR gene editing advances" 15
本文档中的
scripts/search
命令是相对于该工具的安装目录的。
运行任何命令前,使用以下命令定位脚本:
bash
LITERATURE_SCRIPT=$(find ~/.claude/plugins/cache -name "search" -path "*/literature-search/*/scripts/*" -type f 2>/dev/null | head -1)
然后使用完整路径执行所有命令:
bash
$LITERATURE_SCRIPT "CRISPR gene editing advances" 15

API Key Setup Flow

API密钥设置流程

When you run a search and receive
"setup_required": true
, follow this flow:
  1. Ask the user for their API key: "To search scientific literature, I need your Valyu API key. Get one free ($10 credits) at https://platform.valyu.ai"
  2. Once the user provides the key, run:
    bash
    scripts/search setup <api-key>
  3. Retry the original search.
当你运行搜索并收到
"setup_required": true
的返回结果时,请按照以下流程操作:
  1. 向用户索要API密钥: "要搜索科学文献,我需要你的Valyu API密钥。可前往https://platform.valyu.ai免费获取(赠送10美元额度)"
  2. 用户提供密钥后,运行以下命令:
    bash
    scripts/search setup <api-key>
  3. 重新执行原搜索。

When to Use This Skill

适用场景

  • Comprehensive literature reviews across all domains
  • Finding all relevant research on a topic
  • Cross-domain scientific discovery
  • Combining biomedical, physics, and preprint literature
  • Emerging research across disciplines
  • 跨领域的综合性文献综述
  • 查找某一主题的所有相关研究
  • 跨领域科学发现
  • 整合生物医学、物理学和预印本文献
  • 跨学科的新兴研究

Output Format

输出格式

json
{
  "success": true,
  "type": "literature_search",
  "query": "CRISPR gene editing advances",
  "result_count": 15,
  "results": [
    {
      "title": "Article Title",
      "url": "https://...",
      "content": "Full article text with figures...",
      "source": "pubmed|arxiv|biorxiv|medrxiv",
      "relevance_score": 0.95,
      "images": ["https://example.com/figure1.jpg"]
    }
  ],
  "cost": 0.025
}
json
{
  "success": true,
  "type": "literature_search",
  "query": "CRISPR gene editing advances",
  "result_count": 15,
  "results": [
    {
      "title": "Article Title",
      "url": "https://...",
      "content": "Full article text with figures...",
      "source": "pubmed|arxiv|biorxiv|medrxiv",
      "relevance_score": 0.95,
      "images": ["https://example.com/figure1.jpg"]
    }
  ],
  "cost": 0.025
}

Processing Results

结果处理

With jq

使用jq工具

bash
undefined
bash
undefined

Get article titles

获取文章标题

scripts/search "query" 20 | jq -r '.results[].title'
scripts/search "query" 20 | jq -r '.results[].title'

Get URLs

获取URL

scripts/search "query" 20 | jq -r '.results[].url'
scripts/search "query" 20 | jq -r '.results[].url'

Extract full content

提取全文内容

scripts/search "query" 20 | jq -r '.results[].content'
scripts/search "query" 20 | jq -r '.results[].content'

Filter by source

按来源筛选

scripts/search "query" 20 | jq -r '.results[] | select(.source == "arxiv") | .title'
undefined
scripts/search "query" 20 | jq -r '.results[] | select(.source == "arxiv") | .title'
undefined

Common Use Cases

常见使用场景

Comprehensive Literature Review

综合性文献综述

bash
undefined
bash
undefined

Search across all sources for thorough review

跨所有来源搜索以进行全面综述

scripts/search "mechanisms of cellular senescence" 100
undefined
scripts/search "mechanisms of cellular senescence" 100
undefined

Cross-Disciplinary Research

跨学科研究

bash
undefined
bash
undefined

Find papers spanning multiple fields

查找跨多个领域的论文

scripts/search "quantum computing applications in drug discovery" 50
undefined
scripts/search "quantum computing applications in drug discovery" 50
undefined

Recent Developments

最新进展

bash
undefined
bash
undefined

Get latest preprints and publications

获取最新的预印本和出版物

scripts/search "foundation models for protein folding" 30
undefined
scripts/search "foundation models for protein folding" 30
undefined

Medical Research

医学研究

bash
undefined
bash
undefined

Search biomedical literature comprehensively

全面搜索生物医学文献

scripts/search "immunotherapy checkpoint inhibitors resistance" 40
undefined
scripts/search "immunotherapy checkpoint inhibitors resistance" 40
undefined

Error Handling

错误处理

All commands return JSON with
success
field:
json
{
  "success": false,
  "error": "Error message"
}
Exit codes:
  • 0
    - Success
  • 1
    - Error (check JSON for details)
所有命令返回包含
success
字段的JSON:
json
{
  "success": false,
  "error": "Error message"
}
退出码:
  • 0
    - 成功
  • 1
    - 错误(查看JSON获取详细信息)

API Endpoint

API端点

  • Base URL:
    https://api.valyu.ai/v1
  • Endpoint:
    /search
  • Authentication: X-API-Key header
  • 基础URL:
    https://api.valyu.ai/v1
  • 端点:
    /search
  • 认证方式: X-API-Key请求头

Architecture

架构

scripts/
├── search          # Bash wrapper
└── search.mjs      # Node.js CLI
Direct API calls using Node.js built-in
fetch()
, zero external dependencies.
scripts/
├── search          # Bash包装器
└── search.mjs      # Node.js命令行工具
使用Node.js内置的
fetch()
直接调用API,无外部依赖。

Adding to Your Project

集成到你的项目中

If you're building an AI project and want to integrate Literature Search directly into your application, use the Valyu SDK:
如果你正在构建AI项目,并希望将文献搜索直接集成到你的应用中,请使用Valyu SDK:

Python Integration

Python集成

python
from valyu import Valyu

client = Valyu(api_key="your-api-key")

response = client.search(
    query="your search query here",
    included_sources=["valyu/valyu-pubmed", "valyu/valyu-arxiv", "valyu/valyu-biorxiv", "valyu/valyu-medrxiv"],
    max_results=20
)

for result in response["results"]:
    print(f"Title: {result['title']}")
    print(f"URL: {result['url']}")
    print(f"Content: {result['content'][:500]}...")
python
from valyu import Valyu

client = Valyu(api_key="your-api-key")

response = client.search(
    query="your search query here",
    included_sources=["valyu/valyu-pubmed", "valyu/valyu-arxiv", "valyu/valyu-biorxiv", "valyu/valyu-medrxiv"],
    max_results=20
)

for result in response["results"]:
    print(f"Title: {result['title']}")
    print(f"URL: {result['url']}")
    print(f"Content: {result['content'][:500]}...")

TypeScript Integration

TypeScript集成

typescript
import { Valyu } from "valyu-js";

const client = new Valyu("your-api-key");

const response = await client.search({
  query: "your search query here",
  includedSources: ["valyu/valyu-pubmed", "valyu/valyu-arxiv", "valyu/valyu-biorxiv", "valyu/valyu-medrxiv"],
  maxResults: 20
});

response.results.forEach((result) => {
  console.log(`Title: ${result.title}`);
  console.log(`URL: ${result.url}`);
  console.log(`Content: ${result.content.substring(0, 500)}...`);
});
See the Valyu docs for full integration examples and SDK reference.
typescript
import { Valyu } from "valyu-js";

const client = new Valyu("your-api-key");

const response = await client.search({
  query: "your search query here",
  includedSources: ["valyu/valyu-pubmed", "valyu/valyu-arxiv", "valyu/valyu-biorxiv", "valyu/valyu-medrxiv"],
  maxResults: 20
});

response.results.forEach((result) => {
  console.log(`Title: ${result.title}`);
  console.log(`URL: ${result.url}`);
  console.log(`Content: ${result.content.substring(0, 500)}...`);
});
如需完整的集成示例和SDK参考,请查看Valyu文档