Studentvue

🚀 StudentVue Monorepo

このプロジェクトは、RustライブラリとModel Context Protocol (MCP)サーバーの両方を提供する包括的なStudentVue APIの実装です。ネイティブなRustまたはAIパワードのアプリケーションを通じて、学生情報、成績、出席状況、メッセージなどにアクセスできます。

✨ 主な機能

StudentVue Rust API

StudentVue SOAP API用の型安全なRustクライアントライブラリです。

• 場所:
• 特徴:
  • 適切なエラーハンドリングを備えた型安全なデータモデル
  • Tokioランタイムを介したAsync/awaitサポート
  • 自動的なSOAPエンベロープの構築とXML解析
  • 15以上の完全に実装されたAPIエンドポイント
  • 包括的なテストカバレッジを持ち、本番環境での使用に耐える

StudentVue MCP Server

ClaudeなどのAIアプリケーションがStudentVueデータにアクセスできるようにするModel Context Protocolサーバーです。

• 場所:
• 特徴:
  • 15以上のStudentVue APIエンドポイントをMCPツールとして公開
  • 公式のMCP TypeScript SDKを使用して構築
  • Claude Desktopや他のMCPクライアントとのシームレスな統合
  • 環境変数を介した安全な資格情報の取り扱い

🚀 クイックスタート

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

Claude Desktop、Cursor、および他のMCPクライアントの完全なインストール手順については、packages/studentvue-mcp/INSTALL.mdを参照してください。

💻 使用例

利用可能な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 Guide - モノレポの使い方
• Contributing Guide - 開発ワークフローと標準
• Rust API Documentation
• MCP Server Documentation
• MCP Protocol Documentation

📚 テスト

両方のパッケージには包括的なテストスイートが含まれています。

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

テストを実行する前に、.envファイルにテスト用の資格情報を設定してください。

🤝 コントリビューション

コントリビューションは大歓迎です。詳細については、Contributing Guideを参照してください。 すべてのコントリビューションは以下の条件を満たす必要があります。

• 適切に整形されていること（Rustはrustfmt、TypeScriptはPrettier）
• すべてのリントを通過すること（Rustはclippy、TypeScriptはESLint）
• すべてのテストを通過すること
• 新機能にはテストを含めること

🌟 使用例

開発者向け（Rust API）

• カスタムStudentVue統合を構築
• ネイティブパフォーマンスのモバイルアプリを作成
• 成績監視と通知を自動化
• 学校管理システムと統合

AIアプリケーション向け（MCP Server）

• Claudeに成績に関する質問に答えさせる
• 出席状況の自然言語要約を取得
• 今後の課題とイベントについて質問する
• 成績表を取得して説明する

📄 ライセンス

MIT

🙏 謝辞

このプロジェクトは、コミュニティによるStudentVue SOAP APIの逆エンジニアリングとドキュメント化に基づいています。