Dixa MCP Server

Dixa MCP サーバー

Dixa API 用の FastMCP サーバー実装。会話とタグを管理するためのリソースとツールを提供します。

特徴

  • リソース
    • 会話を検索
    • 会話の詳細を取得する
    • 会話メモを取得する
    • 会話メッセージを取得する
    • 利用可能なタグを取得する
  • ツール
    • 会話にタグを追加する
    • 会話からタグを削除する

プロジェクト構造

/src ├── dixa.ts # Main server setup ├── config.ts # Configuration and environment settings ├── types.ts # Shared types and error handling ├── resources/ # Resource implementations ├── schemas/ # Zod schemas for validation └── tools/ # Tool implementations

構成

サーバーには次の環境変数が必要です。

  • DIXA_API_KEY : Dixa APIキー
  • DIXA_API_BASE_URL (オプション): デフォルトの API URL を上書きします (デフォルトは ' https://dev.dixa.io/v1 ')

使用法

  1. 環境変数を設定します。
export DIXA_API_KEY='your-api-key'
  1. サーバーを起動します。
    npm start
## Running Your Server ### Test with `mcp-cli` The fastest way to test and debug your server is with `fastmcp dev`: ```bash npx fastmcp dev server.js npx fastmcp dev server.ts

これにより、ターミナルで MCP サーバーをテストおよびデバッグするために、 mcp-cliを使用してサーバーが実行されます。

MCP Inspectorで検査する

もう 1 つの方法は、公式のMCP Inspector使用して Web UI でサーバーを検査することです。

npx fastmcp inspect server.ts

よくある質問

Claude Desktop ではどのように使用しますか?

ガイドhttps://modelcontextprotocol.io/quickstart/userに従って、次の構成を追加します。

{ "mcpServers": { "my-mcp-server": { "command": "npx", "args": [ "tsx", "/PATH/TO/YOUR_PROJECT/src/index.ts" ], "env": { "YOUR_ENV_VAR": "value" } } } }

発達

新しいリソースの追加

  1. src/schemas/にスキーマを作成する
  2. src/resources/にリソースを作成します。
  3. src/dixa.tsにリソースを追加する

リソースの例:

export const myResource = { uri: "dixa://my-resource", name: "My Resource", description: "Description", load: async (args: MyArgs, apiKey: string) => { // Implementation } };

新しいツールの追加

  1. src/tools/にツールを作成する
  2. src/dixa.tsにツールを追加する

ツールの例:

export const myTool = { name: "My Tool", description: "Description", execute: async (args: MyArgs, apiKey: string) => { // Implementation } };

エラー処理

このプロジェクトではカスタム エラー クラスを使用します。

  • DixaError : APIエラーの基本エラークラス
  • DixaValidationError : レスポンス検証失敗の場合

ショーケース

[!注記]

FastMCP を使用してサーバーを開発した場合は、ここでPR を送信して公開してください。

謝辞

貢献

  1. リソースとツールの既存のパターンに従う
  2. 適切なJSDocドキュメントを追加する
  3. types.tsconfig.tsの共有ユーティリティを使用する
  4. 新しい機能を追加する場合はREADMEを更新してください
-
security - not tested
A
license - permissive license
-
quality - not tested

Dixa API 用の FastMCP サーバー実装。AI アシスタントが顧客の会話データとタグを検索、取得、管理できるようになります。

  1. Features
    1. Project Structure
      1. Configuration
        1. Usage
          1. Inspect with MCP Inspector
        2. FAQ
          1. How to use with Claude Desktop?
        3. Development
          1. Adding a New Resource
          2. Adding a New Tool
        4. Error Handling
          1. Showcase
            1. Acknowledgements
              1. Contributing
                ID: pag7zu8nb8