Quip MCP Server

🚀 quip-mcp-server

このプロジェクトは、quipサービスとやり取りするためのMCP（Model Context Protocol）サーバーです。HTTPインターフェースを通じて様々なツールを呼び出し、quipリソースを操作することができます。

🚀 クイックスタート

このセクションでは、quip-mcp-serverの基本的な使い方を説明します。まずはインストールから始めましょう。

📦 インストール

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

以下のコマンドを使用して、pipを介して直接インストールできます。

pip install quip-mcp-server

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

uvを使用して依存関係を管理している場合、以下のコマンドでインストールできます。

uv pip install quip-mcp-server

📚 ドキュメント

環境変数の設定

.envファイルを作成するか（または.env.exampleをコピーして）、必要に応じて内容を変更します。

# 必須：quip APIのアクセストークン
QUIP_TOKEN=your_quip_api_token_here

# オプション：デフォルトのストレージプロバイダー（選択肢：filesystem, s3）
DEFAULT_STORAGE_PROVIDER=filesystem

# オプション：ファイルシステムのストレージパス
FILESYSTEM_STORAGE_PATH=/path/to/storage/files

# オプション：S3ストレージの設定（S3をストレージプロバイダーとして選択した場合）
S3_BUCKET_NAME=your_s3_bucket_name
S3_ENDPOINT_URL=http://localhost:9000  # ローカルのminioを使用する場合
AWS_REGION=us-east-1

ツールリスト

現在実装されているツールは以下の通りです。

1. quip/list_spreadsheets - ユーザーのすべてのスプレッドシートを取得

# 基本的な使用法
mcp quip list_spreadsheets --auth your_api_token

# オプションのパラメーター：
# --all-users：すべてのユーザーのスプレッドシートを表示（管理者権限が必要）
mcp quip list_spreadsheets --auth your_api_token --all-users

2. quip/get_sheet - 特定のスプレッドシートの内容を取得

# 基本的な使用法
mcp quip get_sheet --auth your_api_token --sheet-id sheet_id_here

3. quip/update_sheet - スプレッドシート内のデータを更新

# 基本的な使用法
mcp quip update_sheet --auth your_api_token --sheet-id sheet_id_here \\
--data '{"key1":"value1", "key2":"value2"}'

開発ガイド

プロジェクト構造

プロジェクトのディレクトリ構造は以下の通りです。

quip-mcp-server/
├── src/
│   ├── __init__.py
│   ├── server.py       # メインのMCPサーバー実装
│   ├── quip_client.py  # Quip APIクライアント
│   ├── tools.py        # ツールの定義とハンドラー
│   └── storage.py      # ストレージの抽象化と実装
├── tests/
│   ├── __init__.py
│   ├── test_server.py  # サーバーの単体テスト
│   ├── test_storage.py # ストレージモジュールの単体テスト
│   └── e2e/            # エンドツーエンドテスト
│       ├── __init__.py
│       ├── conftest.py # テストのfixtures
│       └── test_quip_integration.py # Quip APIとの統合テスト
├── .uv/
│   └── config.toml     # uvの設定
├── pyproject.toml      # プロジェクトのメタデータと依存関係（pytestの設定を含む）
├── uvproject.yaml      # uv専用のプロジェクト設定
├── uv.lock             # ロックされた依存関係
├── .python-version     # Pythonのバージョン指定
├── .env.example        # 環境変数のサンプル
└── README.md           # プロジェクトの説明ドキュメント

開発環境の設定

依存関係のインストール

pipを使用してインストールするには、以下のコマンドを実行します。

pip install -r requirements.txt

またはuvを使用してインストールするには、以下のコマンドを使用します。

uv develop quip-mcp-server

サーバーの起動

以下のコマンドでサーバーを起動できます。

python src/server.py

テストガイド

単体テスト

すべての単体テストを実行するには、以下のコマンドを使用します。

pytest tests/

特定のテストファイルを指定するには、以下のコマンドを使用します。

pytest tests/test_server.py -v

エンドツーエンドテスト

統合テストを実行するには（quip APIのアクセス権限が必要）、以下のコマンドを使用します。

pytest tests/e2e/ --auth your_api_token

新しいツールの追加

新しいquipツールを追加するには、以下の手順に従ってください。

1. tools.pyで新しいツールクラスを定義します。
2. server.pyでそのツールを登録します。
3. 対応するビジネスロジックを実装します。
4. 単体テストを作成して提出します。

依存関係管理ガイド

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

pip install quip-mcp-server

または特定のバージョンを指定するには、以下のコマンドを使用します。

pip install quip-mcp-server==1.0.0

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

uv pip install quip-mcp-server

プロジェクトへの貢献ガイド

コミュニティからの貢献を歓迎します！貢献ガイドを参照して、どのように参加するかを確認してください。

📄 ライセンス

このプロジェクトはMIT Licenseに準拠しています。