xbrl-api-minimal

v7.0.0

Published

5 months ago

XBRL財務データAPI - bcrypt認証システム完全移行版

0High
0Medium
0Low

ruisu2000

XBRL API Minimal

XBRL財務データ分析プラットフォーム - Financial Information next (FIN)

環境設定

必要な環境変数

Vercelにデプロイする前に、以下の環境変数を設定してください：

Vercelダッシュボード → Settings → Environment Variables

# Supabase設定（必須）
NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
XBRL_SUPABASE_SERVICE_KEY=your-service-role-key

# アプリケーションURL（本番環境用）
NEXT_PUBLIC_APP_URL=https://xbrl-api-minimal.vercel.app

Supabase設定

Supabaseダッシュボード → Authentication → URL Configuration
- Site URL: https://xbrl-api-minimal.vercel.app
- Redirect URLs:
  - https://xbrl-api-minimal.vercel.app/auth/callback
  - https://xbrl-api-minimal.vercel.app
Email Templates
- Confirm signup: リダイレクトURLを含むテンプレートに更新
- Reset password: リダイレクトURLを含むテンプレートに更新

ローカル開発

# 依存関係のインストール
npm install

# 環境変数の設定
cp .env.example .env.local
# .env.localを編集して実際の値を設定

# 開発サーバーの起動
npm run dev

データベース構成

アプリケーションは以下のスキーマを使用します：

public: 一般的なデータ（ユーザープロファイルなど）
private: セキュアなデータ（APIキー、認証情報）
auth: Supabase認証システム（自動管理）

トラブルシューティング

セッションが維持されない場合

Supabaseの環境変数が正しく設定されているか確認
VercelのEnvironment Variablesに全ての必要な変数が設定されているか確認
Supabase Authentication URLsが正しく設定されているか確認

ビルドエラーが発生する場合

Node.jsバージョンが20.0.0以上であることを確認
全ての依存関係が正しくインストールされているか確認
TypeScriptの型エラーがないか確認（npm run type-check）

MCP (Model Context Protocol) 設定

このプロジェクトは、XBRL Financial MCPサーバーとして動作し、JWTと独自APIキーを組み合わせた認証システムを提供します。

XBRL Financial MCP設定方法

Claude Desktopの設定ファイルを開く

Windows:

%APPDATA%\Claude\claude_desktop_config.json

macOS:

~/Library/Application Support/Claude/claude_desktop_config.json

XBRL Financial MCPサーバーを追加

{
  "mcpServers": {
    "xbrl-financial": {
      "command": "npx",
      "args": ["shared-supabase-mcp-minimal@latest"],
      "env": {
        "XBRL_API_KEY": "your-api-key-from-dashboard",
        "XBRL_JWT_TOKEN": "your-jwt-token",
        "XBRL_API_URL": "https://wpwqxhyiglbtlaimrjrx.supabase.co/functions/v1/gateway"
      }
    }
  }
}

認証システムの仕組み

このプロジェクトは2層認証を実装しています：

JWT認証 (Supabase Auth)
- ユーザー登録・ログイン
- セッション管理
- パスワードリセット
独自APIキー (Private Schema)
- ダッシュボードから発行
- xbrl_v1_ プレフィックス付き
- PBKDF2ハッシュ化して保存

APIキーとJWTトークンの取得方法

アカウント登録
- https://xbrl-api-minimal.vercel.app/auth/register
ダッシュボードにアクセス
- https://xbrl-api-minimal.vercel.app/dashboard
APIキーを発行
- 「APIキー」タブを選択
- 名前を入力して「APIキー発行」をクリック
- ⚠️ APIキーは一度だけ表示されます
JWTトークンを取得
- ダッシュボードの「JWT認証状態」セクションで確認
- または開発者ツールのネットワークタブでAuthorizationヘッダーを確認
MCP設定に追加
- 取得したAPIキーをXBRL_API_KEYに設定
- JWTトークンをXBRL_JWT_TOKENに設定

その他の推奨MCPサーバー

{
  "mcpServers": {
    "supabase": {
      "command": "npx",
      "args": ["-y", "@supabase/mcp"],
      "env": {
        "SUPABASE_URL": "your-url",
        "SUPABASE_SERVICE_KEY": "your-key"
      }
    },
    "github": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your-github-pat"
      }
    },
    "filesystem": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem"],
      "env": {
        "FILESYSTEM_ROOT": "C:/Users/pumpk"
      }
    }
  }
}

MCP環境変数

XBRL Financial MCPサーバーで必要な環境変数：

XBRL_API_URL: Supabase Edge Function Gateway（https://wpwqxhyiglbtlaimrjrx.supabase.co/functions/v1/gateway）
XBRL_API_KEY: ダッシュボードから取得した独自APIキー
XBRL_JWT_TOKEN: Supabase AuthのJWTトークン（ダッシュボードで確認可能）

追加MCPサーバーの環境変数（オプション）：

SUPABASE_URL: Supabaseプロジェクトの URL
SUPABASE_SERVICE_KEY: Service Role Key（管理者権限）
GITHUB_PERSONAL_ACCESS_TOKEN: GitHub API アクセス用

MCPを使った開発ワークフロー

XBRL財務データ取得
- mcp__xbrl__get_companies: 企業情報の取得
- mcp__xbrl__get_documents: 財務報告書の取得
- mcp__xbrl__search_companies: 企業検索
データベース操作 (Supabase MCP併用時)
- mcp__supabase__execute_sql: SQLクエリの実行
- mcp__supabase__apply_migration: マイグレーションの適用
- mcp__supabase__list_tables: テーブル一覧の取得
Edge Function管理 (Supabase MCP併用時)
- mcp__supabase__deploy_edge_function: Edge Functionのデプロイ
- mcp__supabase__list_edge_functions: Edge Function一覧の取得
GitHub連携 (GitHub MCP併用時)
- mcp__github__create_pull_request: プルリクエストの作成
- mcp__github__merge_pull_request: プルリクエストのマージ

セキュリティ注意事項

⚠️ 重要: Service Role Keyは管理者権限を持つため、以下の点に注意：

Service Role Keyをコミットしない
.env.localファイルで管理する
本番環境では環境変数として設定
MCPの設定ファイルはGitにコミットしない

デプロイ

Vercelへのデプロイは自動的に行われます（mainブランチへのpush時）。

手動デプロイ：

vercel --prod

ライセンス

MIT