Unstructured API MCP Server

🚀 非構造化MCPサーバーガイド

非構造化MCPサーバーのセットアップ、使用方法、トラブルシューティングに関する詳細なガイドです。

🚀 クイックスタート

このセクションでは、非構造化MCPサーバーを迅速に起動する方法を説明します。

Makeコマンドを使用した起動

make server           # MCPサーバーを起動します（SSEモード）
make sse-server      # SSEプロトコルサーバーを起動します
make sse-client      # SSEモードのクライアントを実行します
make stdio-server    # Stdioプロトコルサーバーを起動します

手動起動

1. MCPサーバーを起動します（SSEモード）：

   uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080
   

2. デバッグ画面を起動します：

   mcp dev uns_mcp/server.py
   

✨ 主な機能

• 非構造化MCPサーバーの提供
• SSEおよびStdioプロトコルサーバーのサポート
• クライアントとの通信機能
• デバッグツールの提供

📦 インストール

仮想環境を使用したインストール

1. Python仮想環境を作成してアクティブにします：

   python -m venv ./.venv && source ./.venv/bin/activate
   

2. プロジェクトの依存関係をインストールします：

   pip install -r requirements.txt
   

クイックインストール（オプション）

サンプルを実行するだけの場合は、以下のコマンドを使用して必要なすべてのファイルを直接取得できます：

make init

💻 使用例

基本的な使用法

# MCPサーバーを起動します（指定したポートとホスト）
uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

# デバッグモードで起動します
DEBUG=1 uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

高度な使用法

uv run python minimal_client/client.py --help

📚 ドキュメント

プロジェクト構造の説明

.
├── CHANGELOG.md                  # バージョン更新ログ
├── README.md                     # ユーザーガイド
├── requirements.txt             # 依存関係管理ファイル
├── Makefile                      # 自動化ビルドスクリプト
├── uns_mcp/                     # 非構造化MCPサーバーコード
│   ├── server.py                # メインサービスエントリー
│   └── __init__.py              # パッケージ初期化ファイル
└── minimal_client/               # 最小限のクライアントコード
    ├── client.py                 # クライアントメインプログラム
    ├── __init__.py               # パッケージ初期化ファイル
    └── tools/                    # ツールモジュール
        └── uns_structured.py     # 非構造化ツールインターフェイス

設定の説明

環境変数の設定

• LOG_LEVEL：ログレベルを設定します。選択肢はDEBUG、INFO、WARNING、ERRORで、デフォルトはINFOです。
• DEBUG_API_REQUESTS：APIリクエストパラメータのデバッグ出力を有効または無効にします。デフォルトはFalseです。

ツールモジュールの説明

1. minimal_client/tools/uns_structured.py：
   • 非構造化サービスとのやり取り用のインターフェイスを提供します。ファイル処理、モデル呼び出しなどの機能が含まれます。

デバッグツール

Anthropic MCPチェッカーの使用

以下のコマンドを実行してデバッグ画面を起動します：

mcp dev uns_mcp/server.py

クライアント端末アクセス

@wonderwhy-er/desktop-commander パッケージを使用して端末アクセス権を追加します：

1. パッケージをインストールします：

   npx @wonderwhy-er/desktop-commander setup
   

2. クライアントを起動するときにパラメータを追加します：

   uv run python minimal_client/client.py "http://127.0.0.1:8080" --terminal
   

既知の問題

一般的なエラー

• ポート競合：起動に失敗してポートが使用中であると表示された場合は、ポートを変更してください：

  uv run python uns_mcp/server.py --host 127.0.0.1 --port 8081
  

トラブルシューティング

ログの確認

• サービスログを確認します：

  tail -f uns_mcp/logs/server.log
  

付録

コマンドラインツール

起動コマンドの例

# MCPサーバーを起動します（指定したポートとホスト）
uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

# デバッグモードで起動します
DEBUG=1 uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

クライアントの使用例

uv run python minimal_client/client.py --help

高度なトピック

拡張開発

• minimal_client/tools/ ディレクトリにさらに多くのツールモジュールを拡張します。

カスタムログ形式

logging_config.yml ファイルを変更して、ログ出力形式をカスタマイズします：

handlers:
  file_handler:
    class: logging.FileHandler
    filename: logs/server.log
    mode: a
    formatter: customFormatter
formatters:
  customFormatter:
    format: "%(asctime)s - %(levelname)s - %(message)s"

文書履歴

変更履歴

• v1.0：基本機能とドキュメントを含む初期バージョンがリリースされました。
• v1.1：新しいデバッグツールのサポートが追加され、ログシステムが最適化されました。

詳細なヘルプが必要な場合は、プロジェクトのソースコードを参照するか、メンテナンスチームにお問い合わせください。