Smar MCP

🚀 スマートMCPサーバー：Smartsheet統合

このプロジェクトは、Smartsheetと統合し、Claude for Desktopを通じた対話をサポートするスマート最小実行可能製品（MCP）サーバーを提供します。以下にプロジェクトの詳細情報を示します。

🚀 クイックスタート

入門ガイド

1. 環境変数の設定

   • Smartsheet APIの認証に使用する SMARTSHEET_API_KEY 環境変数を設定します。
   • オプション：削除操作を有効にするには、ALLOW_DELETE_TOOLS を 'true' に設定します。デフォルトでは無効になっています。

2. 依存関係のインストール

   npm install
   

3. 開発環境の起動

   npm run dev
   

4. 統合テスト

   • Claude Desktop Quickstart を参照して、ローカルでテストを行います。
   • claude_desktop_config-example.json を設定テンプレートとして使用し、必要に応じて環境変数を調整します。

✨ 主な機能

核心機能

1. 直接APIアクセス：Smartsheetの直接APIクライアントを介して、Smartsheetの操作を実行します。
2. ツール定義：src/index.ts でMCPツールを定義し、作成、読み取り、更新、削除などのさまざまな操作をサポートします。
3. ユーティリティ関数：一般的な操作の補助関数を提供し、開発プロセスを簡素化します。

サポートされる操作

• 作成/読み取り/更新/削除 (CRUD)：Smartsheetのプロジェクト、タスク、コメントなどに対してCRUD操作を実行します。
• 複雑なワークフロー：複雑なビジネスロジックと自動化ワークフローを実装します。
• データのエクスポートとインポート：データの一括エクスポートとインポート機能をサポートします。

📚 ドキュメント

プロジェクト構造

smartsheet-mcp/
├── src/
│   ├── index.ts                   # メインエントリポイントとMCPツール定義
│   ├── smartsheet-direct-api.ts    # 直接APIクライアントの実装
│   ├── smartsheet-utils.ts         # 共通の補助関数
│   ├── smartsheet-workflows.ts     # 複雑なワークフローの実装
│   └── smartsheet-types.ts        # Smartsheetオブジェクトのクラス表現
├── tests/
│   ├── unit/                     # 単体テストファイル
│   └── integration/              # 統合テストファイル
├── scripts/                      # ツールスクリプト
├── examples/                     # サンプルコードファイル
├── .env                          # 環境変数設定ファイル
├── .env.example                 # 環境変数テンプレート
└── claude_desktop_config-example.json # サンプルClaude Desktop設定ファイル

コードサンプル

以下は、Smartsheet APIを使用して新しいプロジェクトを作成するサンプルコードです。

import { SmartsheetClient } from './src/smartsheet-direct-api';

const client = new SmartsheetClient(process.env.SMARTSHEET_API_KEY);

async function createProject() {
  const projectId = await client.createProject('My New Project');
  console.log(`Project created with ID: ${projectId}`);
}

createProject();

ドキュメントリソース

• 公式ドキュメント：Smartsheet API ドキュメント
• プロジェクトWiki：詳細な開発情報は内部Wikiを参照してください。
• サンプルリポジトリ：examples/ フォルダ内のサンプルコードを参照してください。

🤝 貢献ガイド

コミット規則

Conventional Commits 規則に従い、以下の形式でコミットしてください。

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

タイプ定義

• feat：新機能の追加（メジャーバージョンアップ）
• fix：バグ修正（パッチバージョンアップ）
• docs：ドキュメントの更新
• style：コードフォーマットの調整
• refactor：コードのリファクタリング（新機能や修正なし）
• perf：パフォーマンスの最適化
• test：テストケースの追加/修正
• chore：ビルドツールやその他の補助タスクの調整

破壊的変更

コミットメッセージに BREAKING CHANGE: を追加するか、タイプの後に ! を付けて破壊的変更をマークします。例えば：

feat!: 古いAPIインターフェイスを削除

開発フロー

1. リポジトリをForkする
2. 機能ブランチを作成する (git checkout -b feature/amazing-feature)
3. コードをコミットする：コミット規則に従ってコミットします。
4. PRを提出する：メインブランチにpull requestを提出し、詳細な説明を添付してください。

📄 ライセンス

このプロジェクトは MIT License のオープンソースライセンスの下で公開されています。詳細は以下の通りです。

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

以上のガイドに従えば、Smartsheet MCPサーバーを簡単に使い始めることができます。