Norman MCP Server

🚀 規範 [Norm コマンド] リソースサーバー

このサーバーは Norm コマンドに関連するリソースを提供し、様々な機能モジュールを通じて企業の情報管理や取引管理などを支援します。

🚀 クイックスタート

.env ファイルの作成

.env ファイルをコピーして編集します。

cp .env.template .env
# .env 内に Norman Finance の認証情報を記入してください

開発モードでの実行

MCP チェッカーを使用して開発モードで実行します。

mcp dev norman_mcp/server.py

これによりサーバーが起動し、ブラウザで MCP チェッカーが開き、リソースとツールをテストできます。

✨ 主な機能

Norm コマンド リソースサーバーは以下の機能モジュールを提供します。

会社情報

• 会社詳細の閲覧：company://current リソースを通じてアクセスできます。
• 現在の状態の取得：get_company_status ツールを使用します。

取引管理

• 取引の一覧表示：transactions://list/1/10 リソースを呼び出して最近の取引を確認できます。
• 取引の作成：create_transaction ツールを使用し、金額、説明、キャッシュフロータイプをパラメータとして指定します。
• 取引の検索：search_transactions_prompt プロンプトを通じて日付範囲でフィルタリングできます。

請求書管理

• 請求書の作成：create_invoice ツールを呼び出し、顧客 ID と商品情報を提供する必要があります。
• 請求書の送信：send_invoice ツールを使用し、メールの件名と本文を設定します。
• 取引と請求書の関連付け：link_transaction ツールを通じて取引を請求書に関連付けます。

顧客管理

• すべての顧客の一覧表示：clients://list リソースにアクセスして顧客リストを取得します。
• 詳細情報の閲覧：get_client ツールを呼び出し、顧客 ID を入力して詳細情報を取得します。

文書管理

• ファイルのアップロード：upload_bulk_attachments ツールを使用してファイルを一括アップロードし、取引タイプを指定します。
• 添付ファイルの一覧表示：list_attachments ツールを呼び出し、ファイル名、関連状態、タイプでフィルタリングできます。

税務管理

• 税務報告書の一覧表示：taxes://list リソースにアクセスして利用可能なすべての税務報告書を取得します。
• プレビューの生成：generate_finanzamt_preview ツールを使用してテスト用の Finanzamt プレビューを生成します。
• 報告書の提出：submit_tax_report ツールを呼び出して税務報告書の提出を完了します。

開発

リポジトリのクローン

git clone https://github.com/norman-finance/norman-mcp-server.git
cd norman-mcp-server

依存関係のインストール

pip install -r requirements.txt

サーバーの起動

python server.py

📦 インストール

Norm コマンド リソースサーバーを使用するには、以下の手順でインストールします。

pip を使用したインストール

pip install norm-cmd

リポジトリのクローン（オプション）

コードを変更したり貢献したりする場合は、このリポジトリをクローンできます。

git clone https://github.com/norman-finance/norman-mcp-server.git
cd norman-mcp-server

🔧 設定

仮想環境の作成

Norm コマンド リソースサーバーを実行するには、仮想環境の使用をおすすめします。以下は仮想環境の作成とアクティブ化の手順です。

venv を使用する場合

python -m venv venv
source venv/bin/activate  # Windows の場合：venv\Scripts\activate

uv を使用する場合（推奨）

uv venv
source .venv/bin/activate  # Windows の場合：.venv\Scripts\activate

開発用依存関係のインストール

追加の開発用依存関係をインストールします。

pip install -e ".[dev]"

または uv を使用する場合：

uv pip install -e ".[dev]"

💻 使用例

基本的な使用法

Norm コマンド リソースサーバーを使用する基本的な手順は以下の通りです。

インストール

pip install norm-cmd

開発モードでの実行

mcp dev norman_mcp/server.py

高度な使用法

コードの変更や貢献を行う場合は、以下の手順を参考にしてください。

リポジトリのクローン

git clone https://github.com/norman-finance/norman-mcp-server.git
cd norman-mcp-server

依存関係のインストール

pip install -r requirements.txt

サーバーの起動

python server.py

📚 ツールの概要

会社情報ツール

• get_company_status：会社の現在の状態を取得します。

取引ツール

• create_transaction(amount, description, transaction_type)：新しい取引レコードを作成します。
• search_transactions(start_date, end_date)：日付範囲で取引レコードを検索します。

請求書ツール

• create_invoice(customer_id, items)：新しい請求書を生成し、顧客 ID と商品情報を提供する必要があります。
• send_invoice(invoice_id, subject, body)：指定された請求書をメールで送信し、メールの件名と本文を設定します。

顧客ツール

• get_client(client_id)：指定された顧客 ID の詳細情報を取得します。

📚 プロンプトの概要

取引検索プロンプト

search_transactions(start_date, end_date)

請求書作成プロンプト

create_invoice(customer_id, items)

請求書送信プロンプト

send_invoice(invoice_id, subject, body)