freee サイン(電子契約)ガイド
freee サインは freee 本体とは別の MCP サーバー(freee-sign-mcp)で提供されます。
認証基盤が異なるため、freee 本体の company_id や事業所管理は不要です。
セットアップ
npx --package=freee-mcp -- freee-sign-mcp configureブラウザで freee サインにログインし、OAuth 認証を完了します。設定は ~/.config/freee-mcp/sign-config.json に保存されます。
MCP ツール
認証:
sign_authenticate- freee サイン OAuth 認証sign_auth_status- 認証状態確認sign_clear_auth- 認証情報クリア
API 呼び出し:
sign_api_get- GET リクエストsign_api_post- POST リクエストsign_api_put- PUT リクエストsign_api_patch- PATCH リクエストsign_api_delete- DELETE リクエスト
ファイル操作:
sign_file_upload- ローカルファイルから文書を作成 (POST /v1/documents/uploads または /v1/pdf_documents)
サーバー情報:
sign_server_info- サーバー情報取得(バージョン、transport)
基本ワークフロー
- 認証状態を確認:
sign_auth_status(未認証ならsign_authenticateを実行) - レシピを確認: 文書の作成・ファイルアップロードは
recipes/sign-document-operations.mdを参照 - リファレンスを検索:
sign-references/内の該当リファレンスを参照 - API を呼び出す:
sign_api_*ツールを使用
注意:
- freee 本体の
company_idやfreee_get_current_companyはサインでは使用しません - サインの API パスは
/v1/から始まります(例:/v1/documents)
API ベース URL
サイン API のベース URL は https://ninja-sign.com です(https://sign.freee.co.jp ではありません)。
curl 等で MCP を経由せず直接 API を呼び出す場合は https://ninja-sign.com/v1/... にリクエストしてください。
開発用に環境変数 FREEE_SIGN_API_URL で向き先を上書きできます。
大容量ファイルの送信制限
ファイルから文書を作成する場合は sign_file_upload を使ってください(sign_api_post に数百 KB を超える Base64 body を渡すと失敗するため)。理由と使い分け・手順は recipes/sign-document-operations.md を参照。
レシピ
recipes/sign-document-operations.md- 文書の作成・ファイルアップロード(エンドポイントの使い分け・uploader_id の取得・署名依頼までの流れ)
リファレンス
API リファレンスが sign-references/ に含まれます:
sign-documents.md- 文書管理(作成・送信・検索・ダウンロード)sign-folders.md- フォルダ管理sign-items.md- 入力項目sign-kintone.md- kintone 連携sign-seal-images.md- マイ印鑑sign-teams.md- チーム管理sign-templates.md- テンプレートsign-users.md- ユーザー管理
エラー対応
- 認証エラー:
sign_auth_statusで確認 →sign_clear_auth→sign_authenticate - 設定エラー:
npx --package=freee-mcp -- freee-sign-mcp configure --forceで再設定