rq-scan-mcp
v1.2.1
Published
MCP Server for RQ-SCAN - AI-powered document data extraction platform
Maintainers
Readme
RQ-SCAN MCP Server
RQ-SCANドキュメント処理プラットフォーム用のMCP(Model Context Protocol)サーバーです。
Claude DesktopやClaude CodeからRQ-SCANの機能を直接操作できます。
インストール
npx(推奨)
インストール不要で即座に利用開始できます:
{
"mcpServers": {
"rq-scan": {
"command": "npx",
"args": ["-y", "rq-scan-mcp"],
"env": {
"RQSCAN_API_KEY": "your-api-key",
"RQSCAN_ORGANIZATION_ID": "your-organization-id"
}
}
}
}ローカルインストール
npm install -g rq-scan-mcp環境変数
| 変数名 | 必須 | 説明 | デフォルト |
|--------|------|------|-----------|
| RQSCAN_API_URL | - | RQ-SCAN APIのURL | https://api.rq-scan.com |
| RQSCAN_API_KEY | Yes | APIキー | - |
| RQSCAN_ORGANIZATION_ID | Yes | 組織ID | - |
| RQSCAN_WORKSPACE_ID | - | ワークスペースID | - |
利用可能なツール
ワークフロー管理
list_workflows- ワークフロー一覧を取得get_workflow- ワークフローの詳細情報を取得
スキャン設定(FormatRule)
create_format_rule- スキャン設定を作成・更新get_format_rule- 最新のスキャン設定を取得list_format_rules- スキャン設定の履歴一覧を取得
ファイルアップロード・処理
create_upload_set- アップロードセット(バッチ)を作成upload_file- ファイルをアップロードstart_processing- AI処理を開始get_processing_status- 処理状況を確認
結果取得
get_results- 抽出結果のサマリーを表示export_csv- 結果をCSV形式で出力
Claude Desktopでの設定
macOS
~/Library/Application Support/Claude/claude_desktop_config.json を編集:
{
"mcpServers": {
"rq-scan": {
"command": "npx",
"args": ["-y", "rq-scan-mcp"],
"env": {
"RQSCAN_API_KEY": "your-api-key",
"RQSCAN_ORGANIZATION_ID": "your-organization-id"
}
}
}
}Windows
%APPDATA%\Claude\claude_desktop_config.json を編集:
{
"mcpServers": {
"rq-scan": {
"command": "npx",
"args": ["-y", "rq-scan-mcp"],
"env": {
"RQSCAN_API_KEY": "your-api-key",
"RQSCAN_ORGANIZATION_ID": "your-organization-id"
}
}
}
}設定後、Claude Desktopを再起動してください。
使用例
基本的なワークフロー
1. ワークフロー一覧を確認
→ list_workflows
2. スキャン設定を作成
→ create_format_rule
例: 請求日、金額、発行元などの抽出項目を定義
3. ファイルをアップロード
→ create_upload_set → upload_file
4. AI処理を実行
→ start_processing → get_processing_status(完了まで待機)
5. 結果を確認
→ get_results または export_csvスキャン設定の作成例
ユーザー: 「請求書から請求日、金額、発行元を抽出する設定を作成して」
Claude: create_format_ruleツールを使用して...
設定名: 請求書スキャン設定
抽出項目:
- 請求日: 請求書の発行日をYYYY-MM-DD形式で抽出
- 金額: 請求金額(税込)を数値のみで抽出
- 発行元: 発行元の会社名を抽出ファイル処理と結果取得
ユーザー: 「/path/to/invoice.pdf をアップロードして処理して」
Claude:
1. create_upload_setで「請求書処理」を作成
2. upload_fileでファイルをアップロード
3. start_processingでAI処理を開始
4. get_processing_statusで完了を確認
5. get_resultsで結果を表示
抽出結果:
- 請求日: 2024-01-15
- 金額: 110000
- 発行元: 株式会社サンプルトラブルシューティング
「API key is required」エラー
環境変数 RQSCAN_API_KEY が設定されていません。
- Claude Desktop設定ファイルの
envセクションを確認 - APIキーはRQ-SCAN管理画面から取得可能
「Organization ID is required」エラー
環境変数 RQSCAN_ORGANIZATION_ID が設定されていません。
- RQ-SCANの管理画面で組織IDを確認
- 設定ファイルに追加
Claude Desktopでツールが表示されない
- 設定ファイルのJSON構文が正しいか確認
- Claude Desktopを完全に再起動
npx -y rq-scan-mcpをターミナルで直接実行してエラーを確認
ファイルアップロードが失敗する
- 対応形式: PDF, JPEG, PNG
- ファイルパスが正しいか確認(絶対パス推奨)
- ファイルサイズ制限を確認
開発者向け
ローカルビルド
git clone https://github.com/RECERQA/rq-scan.git
cd rq-scan/rq-scan-mcp
npm install
npm run build
npm testローカル開発での使用
{
"mcpServers": {
"rq-scan": {
"command": "node",
"args": ["/path/to/rq-scan-mcp/dist/index.js"],
"env": {
"RQSCAN_API_KEY": "your-api-key",
"RQSCAN_ORGANIZATION_ID": "your-organization-id"
}
}
}
}ライセンス
MIT License - Copyright (c) RECERQA Inc.
サポート
- Issues: https://github.com/RECERQA/rq-scan/issues
- ドキュメント: https://rq-scan.com/docs
