Xcode MCP Server

🚀 Xcode MCP サーバー

Xcode MCP サーバーは、Xcode 関連の操作を効率的に行うためのサーバーです。このサーバーを使用することで、Xcode プロジェクトのビルドやツールの実行を簡単に行うことができます。

🚀 クイックスタート

1. ツールの登録

src/tools/ ディレクトリの下に新しいツールカテゴリを作成し、その中でツールを登録します。

// src/tools/build/index.ts
export const build = new Tool({
  name: 'build',
  description: 'Builds an Xcode project or workspace.',
  parameters: {
    // 定義パラメータ schema
  },
})

2. ツールの使用

HTTP リクエストを送信してツールを呼び出します。

curl -X POST http://localhost:3000/tools/build \
     -H "Content-Type: application/json" \
     -d '{"parameter": "value"}'

✨ 主な機能

• サーバーを簡単にインストールして起動できます。
• 許可ディレクトリやログレベルの設定が可能です。
• 新しいツールを登録して使用できます。
• セキュリティ対策として、パス検証とエラー処理が行われます。

📦 インストール

以下の手順に従って、Xcode MCP サーバーをインストールしてください。

1. リポジトリのクローン

git clone https://github.com/yourusername/xcode-mcp-server.git
cd xcode-mcp-server

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

npm install

3. サーバーの起動

npm start

デフォルトでは、サーバーは localhost:3000 で動作します。

💻 使用例

基本的な使用法

// src/tools/build/index.ts
export const build = new Tool({
  name: 'build',
  description: 'Builds an Xcode project or workspace.',
  parameters: {
    // 定義パラメータ schema
  },
})

高度な使用法

curl -X POST http://localhost:3000/tools/build \
     -H "Content-Type: application/json" \
     -d '{"parameter": "value"}'

📚 ドキュメント

設定ガイド

1. 許可ディレクトリの設定

プロジェクトのルートディレクトリに .env ファイルを作成します。

ALLOWED_DIRS=/path/to/your/project/directory

2. ログレベルの設定

src/server.ts ファイルを編集して、ログレベルを設定します。

const logger = Logger({
  level: 'info', // 選択可能な値: 'debug'、'info'、'warn'、'error'
})

安全ガイド

1. パス検証

すべてのファイル操作は、許可されたディレクトリ内に制限されます。

const path = await validatePathAgainstAllowedDirs(filePath);

2. エラー処理

ツールの実行時にエラーが発生した場合、エラー情報がキャプチャされて記録されます。

try {
  // ツールのロジックを実行
} catch (error) {
  logger.error(error.message);
}

高度なトピック

1. カスタムツールの分類

src/tools/ ディレクトリの下に新しいサブディレクトリを作成し、対応する index.ts ファイルでツールを登録します。

// src/tools/custom/index.ts
export const customTool = new Tool({
  name: 'custom',
  description: 'Custom Xcode operation.',
  parameters: {
    // 定義パラメータ schema
  },
})

2. 拡張ログ記録

カスタムログ形式と出力を設定します。

const logger = Logger({
  format: ({ level, message }: { level: string; message: string }) =>
    `${new Date().toISOString()} [${level.toUpperCase()}] ${message}`,
});

よくある質問

Q1. パスアクセスエラーはどう処理しますか？

A: アクセスしようとしているパスが許可されたディレクトリ内にあることを確認してください。

Q2. ビルドが失敗するのはなぜですか？

A: Xcode コマンドラインツールがインストールされていることと、バージョンが正しいことを確認してください。

Q3. ツールが認識されないのはなぜですか？

A: ツール名が正しいことを確認し、index.ts ファイルでツールが登録されていることを確認してください。

貢献ガイド

貢献を歓迎します！以下の手順に従って Pull Request を送信してください。

1. リポジトリを Fork する
2. 機能ブランチを作成する（git checkout -b feature/amazing-feature）
3. 変更をコミットする（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュする（git push origin feature/amazing-feature）
5. Pull Request を送信する

開発ガイド

• 既存のコードスタイルと組織構造に従ってください。
• Zod スキームを使用してパラメータの検証を行い、詳細なエラーメッセージを追加してください。
• 新機能に対してテストケースを作成してください。
• 変更内容を反映するようにドキュメントを更新してください。
• 異なるプロジェクトタイプ（標準、ワークスペース、SPM）との互換性を確保してください。

新しいツールの追加

サーバーに新しいツールを追加するには、以下の手順を実行してください。

1. src/tools/ ディレクトリ内で適切なカテゴリを決定します。
2. 既存のパターンを使用してツールを実装し、Zod スキームで検証します。
3. そのカテゴリの index.ts ファイルでツールを登録します。
4. エラー処理と具体的なエラーメッセージを追加します。
5. 新しいツールを記録するためにドキュメントを更新します。

📄 ライセンス

[ここにライセンス情報を挿入]

さらなる支援が必要な場合は、FAQ ページ を参照するか、サポートチームにお問い合わせください。

⚠️ 重要提示

• 許可されたディレクトリには正しいアクセス権限があることを確認してください。
• 古いログファイルを定期的に削除して、ディスク容量が不足しないようにしてください。
• サーバーが使用している Xcode バージョンと互換性があることを確認してください。