nsip (Zircote)

nsip

](https://github.com/zircote/nsip)    ](https://www.rust-lang.org/)     

绵羊遗传评估CLI和MCP服务器——通过NSIP数据库搜索动物、比较EBV、计划交配、对羊群进行排名。

试试看： 克隆 zircote/nsip示例 用于预配置MCP服务器配置、示例工作流和AI助手指令的即用型农场存储库。

特性

• 类型安全的API客户端 具有全面的错误处理功能
• 搜索功能 按品种组、状态和其他标准对动物进行分类
• 详细的动物信息 包括血统和后代
• MCP（模型上下文协议）集成 AI助手兼容性
• CLI工具 具有多个子命令，便于交互
• 异步/等待支持 使用tokio运行时
• 完整文档 所有公共API中都有示例

安装

将此添加到您的 Cargo.toml:

[dependencies]
nsip = "0.4"

或使用货物添加：

cargo add nsip

快速开始

use nsip::{NsipClient, SearchCriteria};

#[tokio::main]
async fn main() -> Result {
    // Create a new client
    let client = NsipClient::new();

    // List available breed groups
    let breed_groups = client.breed_groups().await?;
    println!("Available breed groups: {}", breed_groups.len());

    // Search for animals
    let criteria = SearchCriteria::new()
        .with_status("CURRENT");

    let results = client
        .search_animals(0, 15, Some(640), None, None, Some(&criteria))
        .await?;
    println!("Found {} animals", results.total_count);

    // Get details for a specific animal
    let animal = client.animal_details("LPN_ID_HERE").await?;
    println!("Animal: {}", animal.lpn_id);

    Ok(())
}

CLI使用情况

这 nsip CLI提供了几个用于与NSIP Search API交互的命令：

# Get database last-updated date
nsip date-updated

# List breed groups
nsip breed-groups

# List animal statuses
nsip statuses

# Get trait ranges for a breed
nsip trait-ranges 640

# Search for animals
nsip search --breed-id 640 --status CURRENT --page 0 --page-size 15

# Get animal details
nsip details 

# Get animal lineage
nsip lineage 

# Get animal progeny
nsip progeny 

# Get full profile (details + lineage + progeny)
nsip profile 

# Compare two or more animals side-by-side
nsip compare  

# Generate shell completions
nsip completions bash

# Generate man pages
nsip man-pages ./man/

# Start MCP server mode
nsip mcp

API概述

客户端方法

数据类型

MCP集成

该库包括MCP（模型上下文协议）支持，用于与AI助手集成：

use nsip::mcp::{serve_stdio, tool_sets::EnabledToolSets};

// Start the MCP server on stdio (all 13 tools enabled)
serve_stdio(EnabledToolSets::all()).await?;

MCP协议在运行时公开了以下13个工具 nsip mcp:

• search -使用品种、性别、状态、日期范围和羊群过滤器搜索动物
• details -获取动物的详细EBV数据、品种、联系信息和状态
• lineage -获取家谱/祖先树，包括父母和祖父母
• progeny -获取动物后代的分页列表
• profile -一次通话即可获取完整的个人资料（详细信息+血统+后代）
• breed_groups -列出所有品种组和单个品种
• trait_ranges -获取特定品种的最小/最大EBV性状范围
• compare -并排比较2-5只动物的EBV特征
• rank -根据加权EBV特征对同一品种内的动物进行排名
• inbreeding_check -计算父女配对的赖特近亲繁殖系数
• mating_recommendations -根据特征互补性和COI找到最佳伴侣
• flock_summary -总结一群动物：计数、性别分类和平均EBV
• database_status -获取最后更新日期和可用动物状态

发展

先决条件

• Rust 1.92+（2024年版）
• 货物拒绝 供应链安全

设置

# Clone the repository
git clone https://github.com/zircote/nsip.git
cd nsip

# Build
cargo build

# Run tests
cargo test

# Run linting
cargo clippy --all-targets --all-features

# Format code
cargo fmt

# Check supply chain security
cargo deny check

# Generate documentation
cargo doc --open

项目结构

crates/
├── lib.rs           # Library entry point
├── main.rs          # Binary entry point
├── client.rs        # HTTP client for the NSIP Search API
├── models.rs        # Data models (SearchCriteria, AnimalDetails, etc.)
├── format.rs        # Human-readable ASCII table formatting
└── mcp/             # MCP server (13 tools, prompts, resources)

tests/
├── integration_test.rs
└── cli_test.rs      # CLI integration tests

Cargo.toml           # Project manifest
clippy.toml          # Clippy configuration
rustfmt.toml         # Formatter configuration
deny.toml            # cargo-deny configuration
CLAUDE.md            # AI assistant instructions
AGENTS.md            # AI coding agent instructions
.editorconfig        # Cross-editor defaults
.devcontainer/       # Codespaces / dev container config
.vscode/             # VS Code settings and extensions

代码质量

该项目保持高代码质量标准：

• 代码检查：夹着迂腐和幼稚的绒毛
• 格式化：具有自定义配置的rustfmt
• 测试：单元测试、集成测试和基于属性的测试
• 文档：所有公共API都有示例记录
• 供应链：货物拒绝依赖性审计
• CI/CD：GitHub自动化测试操作

运行检查

# Run all checks
cargo fmt -- --check && \
cargo clippy --all-targets --all-features -- -D warnings && \
cargo test && \
cargo doc --no-deps && \
cargo deny check

# Run with MIRI for undefined behavior detection
cargo +nightly miri test

CI/CD和部署

此模板包括生产就绪工作流：

持续集成

• 持续集成 (.github/workflows/ci.yml)-格式、lint、测试、文档、供应链安全、MSRV检查、覆盖率
• 安全审计 (.github/workflows/security-audit.yml)-每日货物审计扫描
• CodeQL 分析 (.github/workflows/codeql-analysis.yml)-推送/PR和每周时间表的SAST扫描
• 基准 (.github/workflows/benchmark.yml)-有标准的绩效跟踪
• ADR验证 (.github/workflows/adr-validation.yml)-架构决策记录验证

发布和部署

• 发布 (.github/workflows/release.yml)-使用多平台二进制文件自动发布GitHub

- 构建版本：Linux(x86_64ARM64）、macOS(x86_64、ARM64）、Windows(x86_64) - 自动生成变更日志 - 二进制工件上传到版本

• 更新日志 (.github/workflows/changelog.yml)-自动生成CHANGELOG.md

- 使用git cliff进行常规提交 - 遵循保持变更日志格式 - 在版本标签上触发

• 码头工人 (.github/workflows/docker.yml)-多平台容器构建

- 平台：linux/amd64、linux/arm64 - 分散基础映像以实现安全 - 发布到GitHub容器注册表（ghcr.io） - 标记为版本和“最新”

• 发布 (.github/workflows/publish.yml)-自动化crates.io发布

- 完整的预发布验证 - 在版本标签上触发 - 需要 CARGO_REGISTRY_TOKEN 秘密

创建发布

1. 更新版本 Cargo.toml
2. 创建并推送版本标签：

   git tag -a v0.4.0 -m "Release v0.4.0"
   git push origin v0.4.0

1. 自动工作流：

- 生成变更日志 - 为所有平台构建二进制文件 - 使用工件创建GitHub版本 - 构建和推送Docker镜像 - 发布到crates.io

AI 编程助手

• 副驾驶设置 (.github/workflows/copilot-setup-steps.yml)GitHub Copilot编码代理的环境
• 代理说明: AGENTS.md, .github/copilot-instructions.md, CLAUDE.md
• 特定路径说明: .github/instructions/ 用于Rust代码和测试模式
• 可重复使用的提示: .github/prompts/ 用于常见的开发任务

Docker使用

拉动并运行容器：

# Pull latest
docker pull ghcr.io/zircote/nsip:latest

# Run specific version
docker pull ghcr.io/zircote/nsip:v0.4.0
docker run --rm ghcr.io/zircote/nsip:v0.4.0 --version

MSRV政策

最低支持的Rust版本（MSRV）为 1.92增加MSRV被认为是一个微小的突破性变化。

贡献

看 贡献.md 用于开发设置、PR检查表和编码标准。

请同时查看：

• 代码_OF_CONDUCT.md -社区指南
• 安全.md -漏洞报告
• 总经理 -决策过程

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

• Rust编程语言
• 货物
• Clippy