使用说明
🧬 BioFinder MCP
在Galaxy CVMFS上查找作为Singularity容器提供的生物信息学工具-
并准备进行复制 singularity 从您的终端发出命令。
⚠️ 警告:此项目正在积极开发中。该工具根据以下内容返回结果 可用性建议进行独立研究,以确定最适合您的数据和需求的工具。
它有什么作用?
BioFinder是一个 模型上下文协议 (MCP) 服务器+CLI客户端。它索引了两个数据源:
| 数据来源 | 内容 |
|---|---|
toolfinder_meta.yaml |
714条工具记录,包括描述、操作和主页链接。 来源(AustralianBioCommons/finder-service-metadata) ↗ |
galaxy_singularity_cache.json.gz |
银河CVMFS上的118594个奇点容器图像(快照:2026-01-28) |
给定工具名称或您想要做的事情的描述,BioFinder会返回
最新容器路径和可复制粘贴 singularity 命令。
输出示例
biofinder> find fastqc
======================================================================
🧬 FASTQC
======================================================================
📝 Description:
This tool aims to provide a QC report which can spot problems or biases which originate either in the sequencer or in the starting library material. It can be run in one of two modes. It can either run as a stand alone interactive application for the immediate analysis of small numbers of FastQ files, or it can be run in a non-interactive mode where it would be suitable for integrating into a larger analysis pipeline for the systematic processing of large numbers of files.
🌐 Homepage: http://www.bioinformatics.babraham.ac.uk/projects/fastqc/
⚙️ Operations: Sequence composition calculation, Sequencing quality control, Statistical calculation
──────────────────────────────────────────────────────────────────────
📦 AVAILABLE CONTAINERS (27 versions)
──────────────────────────────────────────────────────────────────────
✨ Most Recent Version: 0.12.1--hdfd78af_0
Path: /cvmfs/singularity.galaxyproject.org/all/fastqc:0.12.1--hdfd78af_0
Size: 279.8 MB
──────────────────────────────────────────────────────────────────────
💡 USAGE EXAMPLES
──────────────────────────────────────────────────────────────────────
# Execute a command in the container
singularity exec /cvmfs/singularity.galaxyproject.org/all/fastqc:0.12.1--hdfd78af_0 \
fastqc --help
# Run interactively
singularity shell /cvmfs/singularity.galaxyproject.org/all/fastqc:0.12.1--hdfd78af_0
──────────────────────────────────────────────────────────────────────
📚 OTHER VERSIONS
──────────────────────────────────────────────────────────────────────
1. 0.12.1--hdfd78af_0
/cvmfs/singularity.galaxyproject.org/all/fastqc:0.12.1--hdfd78af_0
2. 0.11.9--hdfd78af_1
/cvmfs/singularity.galaxyproject.org/all/fastqc:0.11.9--hdfd78af_1
3. 0.11.9--0
/cvmfs/singularity.galaxyproject.org/all/fastqc:0.11.9--0
... and 24 more versions
======================================================================
快速开始
设置
首先,克隆并移动到存储库中。
git clone https://github.com/Sydney-Informatics-Hub/bio-finder.git
cd bio-finder
安装Python和所需的库。依赖关系列在 requirements.txt.
chmod +x setup.sh
./setup.sh
示例用法
本迷你教程演示了启动该工具的示例,显示了支持的命令,以及查找可用于序列比对的可用软件的推荐流程。
选择(序列对齐)工具后,您可以显示有关文件系统上可用版本的更多信息。
# Enter interactive mode
./biofinder
# Display help message
biofinder> help
# Search for tools related to sequence alignment
biofinder> search sequence alignment
# Find a specific tool with more information
biofinder> find clustalo
# Display all available versions
biofinder> versions clustalo
# Build an Lmod module from CVMFS (requires sudo)
biofinder> build samtools
# List CVMFS versions without building a module
biofinder> cvmfs-list samtools
从CVMFS构建Lmod模块
BioFinder可以自动创建 Lmod CVMFS中可用工具的模块文件 /cvmfs/singularity.galaxyproject.org/all。此功能需要:
- CVMFS已安装且易于接近
- 系统上安装了Lmod
- 写入权限
/apps/Modules/modulefiles(跑步sudo)
使用示例
# Build module for latest version of samtools
./biofinder build samtools
# Build module for specific version
./biofinder build samtools/1.21
# List available versions without building
./biofinder cvmfs-list samtools
输出示例
在构建模块而不指定版本时:
Available versions:
- 1.22--hdfd78af_0
- 1.21--h50ea8bc_0
- 1.20--h50ea8bc_0
You did not specify a version.
Defaulting to newest version: 1.22--hdfd78af_0
If you want a specific version:
bio-finder build samtools/1.21
Module successfully created.
To load:
module load samtools/1.22--hdfd78af_0
生成的模块文件将保存到 /apps/Modules/modulefiles/<tool>/<version>.lua 并且可以使用标准加载 module load 命令。
加载多个模块
您可以同时加载多个生物信息学工具。每个模块独立工作:
# Load multiple tools at once
module load samtools/1.23--h96c455f_0 bwa/0.7.19--h577a1d6_0 bedtools/2.31.1--hf5e1c6e_0
# Check what's loaded
module list
# All tools are available simultaneously
samtools
bwa
bedtools --version
# Unload specific tools
module unload samtools
# Clear all modules
module purge
这允许您使用工作流所需的所有工具设置完整的分析环境。
需求
对于CVMFS模块构建器功能:
- CVMFS:必须安装在
/cvmfs/singularity.galaxyproject.org/all - Lmod:必须安装并可用(
module命令) - 权限:写入访问权限
/apps/Modules/modulefiles(跑步sudo用于模块创建) - 奇点:必须在系统上可用(由模块自动加载)
使用情况摘要
# Traditional bio-finder commands (query container metadata)
./biofinder find samtools
./biofinder search "sequence alignment"
./biofinder versions samtools
# New CVMFS module builder commands
./biofinder cvmfs-list samtools # List versions in CVMFS
./biofinder build samtools # Build module with latest version
./biofinder build samtools/1.22--h96c455f_0 # Build specific version
# For automated scripts/VM builds (preserves Python environment)
sudo -E env "PATH=$PATH" ./biofinder build samtools
sudo -E env "PATH=$PATH" ./biofinder build samtools/1.22--h96c455f_0
# Interactive mode (includes all commands except build)
./biofinder
# After building modules, load and use them
module load samtools/1.22--h96c455f_0 # Load single module
module load samtools bwa bedtools # Load multiple modules
module list # Check loaded modules
samtools # Use the tools
自动/脚本使用
对于VM构建脚本和自动化,您有两个选择:
选项1:直接命令
# Individual commands (preserves Python environment)
sudo -E env "PATH=$PATH" ./biofinder build samtools
sudo -E env "PATH=$PATH" ./biofinder build fastqc
sudo -E env "PATH=$PATH" ./biofinder build bowtie2
选项2:自动化脚本(推荐)
# Build multiple tools with one command
./build-modules.sh samtools fastqc bowtie2
# Build specific versions
./build-modules.sh samtools/1.22--h96c455f_0 fastqc/0.12.1--hdfd78af_0
# Use in VM build scripts
#!/bin/bash
cd /path/to/bio-finder
./build-modules.sh samtools fastqc bowtie2 bwa minimap2
# Then load them all for a complete analysis environment
module load samtools fastqc bowtie2 bwa minimap2
自动化脚本(build-modules.sh)自动处理sudo权限和环境保护。
⚠️ 警告:该工具返回的结果基于 可用性建议进行独立研究,以确定最适合您的数据和需求的工具。
下一步行动
有关有效使用BioFinder的所有可用选项、示例和提示的概述,请参阅 如何查询.
如果您更喜欢命令行版本(例如用于脚本编写和可重复性),请参阅 命令参考.
BioFinder正在积极开发中,计划改进功能、搜索结果的准确性和实施。看 未来改进.