mcp-nlp

mcp-nlp

MCP-NLP は、Model Context Protocol（MCP）を使用して NLP（自然言語処理）機能を提供するために設計された FastMCP アプリケーションです。

• FastMCP Framework v2：高速で Python らしい MCP サーバーを構築するための最新のフレームワークです。
• Model Context Protocol (MCP)：LLM コンテキストの管理と制御を可能にするプロトコルです。
• NLP-modules
  • textdistance：テキスト距離の指標を計算するモジュールです

前提条件

始める前に、以下がインストールされていることを確認してください。

• Python 3.12
• Docker
• uv

インストール

1. リポジトリをクローンします。

   git clone https://github.com/tivaliy/mcp-nlp.git
   cd mcp-nlp
   

2. 依存関係をインストールします（uv を使用）。

   uv sync
   

設定

認証モード

MCP-NLP サーバーは、次の 2 つの認証モードをサポートしています。

1. 認証なしモード（デフォルト）：

   • サーバーへのアクセスに API キーは不要です
   • 環境変数 API_KEY_ENABLED=False を設定します

2. API キー認証：

   • リクエストヘッダーに有効な API キーが必要です
   • 環境変数 API_KEY_ENABLED=True と API_KEY=your-secret-key を設定します
   • デフォルトのヘッダー名は X-API-Key です（API_KEY_NAME で変更できます）

.env ファイルの例：

# Authentication configuration
API_KEY_ENABLED=True
API_KEY=not-a-secret
# API_KEY_NAME=X-API-Key  # Optional: customize header name

利用可能なツール

MCP-NLP サーバーは現在、次の MCP ツールを提供しています。

テキスト距離モジュール

さまざまなアルゴリズムを使用して、テキストシーケンス間の類似度／距離を計算します。

• #textdistance_measure：

  • 目的：2 つの文字列シーケンス間のテキスト距離を測定します
  • パラメーター：
    • source（必須）：ソーステキスト文字列
    • reference（必須）：比較対象となる参照テキスト文字列
    • algorithm（任意）：使用するアルゴリズム（デフォルト：levenshtein）
    • metric（任意）：使用する指標（デフォルト：normalized_similarity）
  • 戻り値：計算された距離／類似度を表す浮動小数点数

• #textdistance_list_metrics：

  • 目的：テキスト距離アルゴリズムでサポートされているすべての指標を一覧表示します
  • パラメーター：なし
  • 戻り値：利用可能な指標のリスト：distance、similarity、normalized_distance、normalized_similarity、maximum

• サポートされている指標：

  • distance：未加工の距離スコア
  • similarity：未加工の類似度スコア
  • normalized_distance：0～1 の範囲に正規化された距離
  • normalized_similarity：0～1 の範囲に正規化された類似度（デフォルト）
  • maximum：アルゴリズムで取り得る最大値

• デフォルトのアルゴリズム：Levenshtein

使用方法

ローカルでの実行

アプリケーションをローカルで実行するには：

1. FastMCP アプリケーションを起動します。

   mcp-nlp --transport streamable-http
   

2. （streamable-http トランスポートの場合）http://127.0.0.1:8000/mcp の MCP サーバーエンドポイントにアクセスします。

Docker を使用した MCP サーバーの実行

Docker コンテナーで MCP サーバーを実行するには：

1. Docker イメージをビルドします。

   docker build -t mcp-nlp .
   

2. Docker コンテナーを実行します。

   docker run --rm -e TRANSPORT=streamable-http -p 8000:8000 mcp-nlp
   

3. （streamable-http トランスポートの場合）http://127.0.0.1:8000/mcp の MCP サーバーエンドポイントにアクセスします。

Docker コンテナーを実行する際は、環境変数 TRANSPORT を streamable-http または sse に設定してください。

VS Code との統合

MCP-NLP サーバーを VS Code で使用するには：

1. MCP-NLP サーバーが実行中であることを確認します

2. VS Code の settings.json にサーバー設定を追加します（stdio トランスポートを使用）。

   {
       "servers": {
           "mcp-nlp": {
               "type": "stdio",
               "command": "${workspaceFolder}/.venv/bin/mcp-nlp",
               "env": {
                    "API_KEY_ENABLED": "false"
                }
            }
        }
    }
   

3. VS Code で MCP を有効にします。

   "chat.mcp.enabled": true,
   "github.copilot.advanced": {
     "mcp.enabled": true
   }
   

4. これで GitHub Copilot を通じて、MCP-NLP ツールを VS Code から直接使用できます

MCP | Model Context Protocol | FastMCP | NLP

ライセンス

このプロジェクトは MIT ライセンスのもとで公開されています。詳細は LICENSE ファイルを参照してください。