Studentvue

🚀 StudentVue Monorepo

StudentVue Monorepo是一個全面的StudentVue API實現方案，它提供了Rust庫和模型上下文協議（MCP）服務器。通過原生Rust或人工智能驅動的應用程序，你可以訪問學生信息、成績、考勤、消息等內容。

🚀 快速開始

Rust API

cd packages/studentvue-api
cargo build --release

將以下內容添加到你的Cargo.toml文件中：

[dependencies]
studenvue = "0.1.0"
tokio = { version = "1.35", features = ["full"] }

基礎用法

use studenvue::{StudentVueClient, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let client = StudentVueClient::new(portal, username, password);
    let info = client.get_student_info().await?;
    println!("Student: {} (Grade {})", info.name, info.grade);
    Ok(())
}

MCP Server

為Cursor快速安裝

手動安裝

cd packages/studentvue-mcp
bun install
bun run build

完整的安裝說明，請查看 packages/studentvue-mcp/INSTALL.md，適用於Claude Desktop、Cursor和其他MCP客戶端。

✨ 主要特性

包介紹

StudentVue Rust API

一個類型安全的Rust客戶端庫，用於訪問StudentVue的SOAP API。

• 位置：
• 特性：
  • 類型安全的數據模型，具備完善的錯誤處理機制。
  • 通過Tokio運行時支持異步/等待操作。
  • 自動構建SOAP信封並解析XML數據。
  • 超過15個完全實現的API端點。
  • 經過全面測試，可用於生產環境。

StudentVue MCP Server

一個模型上下文協議服務器，使Claude等人工智能應用程序能夠訪問StudentVue數據。

• 位置：
• 特性：
  • 超過15個StudentVue API端點以MCP工具的形式暴露。
  • 使用官方MCP TypeScript SDK構建。
  • 可與Claude Desktop和其他MCP客戶端無縫集成。
  • 通過環境變量安全處理憑證信息。

📦 可用的API方法

兩個包都提供對以下StudentVue功能的訪問：

學生信息

• 獲取學生檔案（姓名、年級、學校、聯繫信息）
• 獲取學校信息（校長、地址、電話）

學業記錄

• 獲取成績冊（成績、作業、課程信息）
• 獲取課程表（上課時段、教師、教室）
• 獲取日曆事件
• 獲取作業筆記（取決於學區）

考勤

• 獲取考勤記錄（缺勤、遲到、原因）

溝通

• 獲取教師/管理員的消息
• 將消息標記為已讀

文檔

• 列出可用文檔
• 下載特定文檔
• 列出並下載成績單

健康記錄

• 獲取學生健康信息（健康狀況、就診記錄、免疫接種情況）

實用工具

• 通過郵政編碼搜索學區

🔧 開發

工作區命令

make build          # 構建所有包
make test           # 運行所有測試
make format         # 格式化所有代碼
make lint           # 運行所有代碼檢查工具
make typecheck      # 運行類型檢查
make quality-gates  # 運行所有質量檢查
make clean          # 清理構建產物
make install        # 安裝依賴項

按包開發

Rust API

cd packages/studentvue-api
cargo build && cargo test

MCP Server

cd packages/studentvue-mcp
bun install && bun run build && bun test

📚 項目結構

studentvue/
├── packages/
│   ├── studentvue-api/      # Rust API庫
│   │   ├── src/             # 源代碼
│   │   ├── tests/           # 集成測試
│   │   └── examples/        # 使用示例
│   └── studentvue-mcp/      # MCP服務器
│       ├── src/             # TypeScript源代碼
│       └── dist/            # 構建產物
├── docs/                    # 文檔
├── Cargo.toml               # Rust工作區配置
├── Makefile                 # 構建自動化
└── README.md                # 本文件

📦 配置

兩個包都需要通過環境變量提供StudentVue憑證：

STUDENTVUE_PORTAL=https://your-district.edupoint.com
STUDENTVUE_USERNAME=your_username
STUDENTVUE_PASSWORD=your_password

⚠️ 重要提示

切勿將憑證信息提交到版本控制系統。請始終使用環境變量或.env文件（默認已添加到.gitignore）。

📚 文檔

• Monorepo指南 - 如何使用此monorepo
• 貢獻指南 - 開發工作流程和標準
• Rust API文檔
• MCP服務器文檔
• MCP協議文檔

🧪 測試

兩個包都包含全面的測試套件：

cd packages/studentvue-api && cargo test
cd packages/studentvue-mcp && bun test

在運行測試之前，請在.env文件中設置測試憑證。

🤝 貢獻

歡迎貢獻代碼。詳情請參閱我們的 貢獻指南。 所有貢獻必須滿足以下條件：

• 代碼格式正確（Rust使用rustfmt，TypeScript使用Prettier）
• 通過所有代碼檢查（Rust使用clippy，TypeScript使用ESLint）
• 通過所有測試
• 為新功能添加測試

📋 使用場景

開發者（Rust API）

• 構建自定義的StudentVue集成
• 創建具有原生性能的移動應用
• 自動化成績監控和通知
• 與學校管理系統集成

人工智能應用程序（MCP服務器）

• 使Claude能夠回答有關成績的問題
• 獲取考勤的自然語言摘要
• 查詢即將到來的作業和事件
• 檢索並解釋成績單

📄 許可證

本項目採用MIT許可證。

🙏 致謝

本項目基於社區對StudentVue SOAP API的逆向工程和文檔。