Skim MCP

🚀 Skim MCP Server

Skimのコード変換用の本番環境対応型モデルコンテキストプロトコルサーバー

組み込みのセキュリティ、モニタリング、および本番環境向け機能を備えた、LLMコンテキストウィンドウ用のコードをインテリジェントに圧縮します。

🚀 クイックスタート

これは何ですか？どのように役立ちますか？

簡単に説明すると：

Claude Code（AIコーディングアシスタント）を使用している場合、大規模なコードプロジェクトを分析する際に「コンテキストが長すぎる」という制限に遭遇することがあります。

Skim MCP Serverの機能：

• 📦 コードを自動的に圧縮し、構造を維持しながら60 - 95%の内容を削減します。
• 🧠 Claude Codeがより大規模なプロジェクトを分析できるようにします。
• ⚡ より正確なコード提案と分析を提供します。

前提条件：

• ✅ Claude Codeがインストールされていること。
• ✅ コンピュータにNode.js 18.0.0以上がインストールされていること。

このツールが必要かわからない場合：Claude Codeを頻繁に使用して大規模なコードベースを分析する場合、このツールは非常に役立ちます！

✨ 主な機能

• 🔒 デフォルトで安全 - パス検証、入力サニタイズ、レート制限
• 📊 本番環境モニタリング - 構造化ロギング、ヘルスチェック、メトリクス
• 🚀 高性能 - spawnを使用した高速実行、最適化されたバッファリング
• 🛡️ DoS保護 - リクエスト制限、サイズ制限、タイムアウト処理
• 📝 包括的なロギング - 設定可能なレベルでのWinston統合
• 🧪 完全なテストカバレッジ - 単体テストと統合テストを含む
• 📦 依存関係なし - MCP SDKとWinstonのみ（本番環境の依存関係）

📦 インストール

前提条件

• Node.js >= 18.0.0
• npm、pnpm、またはyarn

オプション1: グローバルインストール（推奨）

# MCPサーバーとSkim CLIの両方をインストール
npm install -g skim-mcp

# または、Skim CLIを個別にインストール
npm install -g rskim

オプション2: プロジェクト内インストール

# プロジェクトディレクトリ内で
npm install skim-mcp

オプション3: ソースからインストール

git clone https://github.com/luw2007/skim-mcp.git
cd skim-mcp
npm install
npm run build

Skimの自動インストール

Skim CLIが見つからない場合、サーバーは自動的にインストールします。

# npm install中（postinstallフック）
npm install skim-mcp

# または、手動で
npm run install-skim

インストールの確認

インストール後、正常にインストールされたことを確認します。

# skim-mcpが利用可能か確認
skim-mcp --version

# Node.jsのバージョンを確認
node --version  # 18.0.0以上である必要があります

skim-mcpが「コマンドが見つかりません」と表示される場合：

# グローバルにインストールされたパッケージを確認
npm list -g skim-mcp

# npmのグローバルパスを確認
npm config get prefix

npmのグローバルパスをシステムのPATHに追加する必要がある場合があります。

🔧 設定

Claude Codeの設定

Claude Codeの設定ファイルを見つけて編集します（オペレーティングシステムによって異なります）。

macOS / Linux:

• ~/.claude/config.json（推奨、最初にこれを試してください）
• または ~/.config/claude-code/config.json

Windows:

• C:\Users\YourUsername\.claude\config.json
• または C:\Users\YourUsername\AppData\Roaming\claude-code\config.json

ファイルが存在しない場合は、作成します。

以下の設定を追加します。

{
  "mcpServers": {
    "skim_mcp": {
      "command": "skim-mcp"
    }
  }
}

⚠️ 重要: 変更を有効にするには、Claude Codeを完全に終了して再起動する必要があります。

環境変数

# ロギングレベル
export LOG_LEVEL=info  # debug, info, warn, error

# 許可されたベースパス（カンマ区切り）
export SKIM_ALLOWED_PATHS=/workspace,/home/user/projects

# レート制限
export SKIM_MAX_REQUESTS_PER_MINUTE=10

# 入力サイズ制限
export SKIM_MAX_INPUT_SIZE=10485760  # 10MB（バイト単位）

設定の成功を確認

Claude Codeを設定して再起動した後、テストします。

1. Claude Codeを開きます。
2. 会話に次のように入力します。

   Help me analyze this project's code structure
   

3. Claude Codeが自動的に mcp__skim__skim_analyze ツールを使用するか確認します。

成功の指標：

• 会話で「Using skim tool to analyze code...」のようなメッセージが表示されます。
• または、ツール呼び出しログに skim_file / skim_analyze の呼び出しが表示されます。

動作しない場合：

• 設定ファイルのJSON形式が有効か確認します（jsonlint.com を使用して検証）。
• Claude Codeを完全に終了して再起動したことを確認します。
• Claude Codeのログファイルにエラーメッセージがないか確認します。

💻 使用例

設定が完了すると、Claude Codeで自動的にツールが利用可能になります。

基本的な使用法

ツール1: skim_transform - ソースコードの変換

文字列からコードを変換します。

// Claude Codeはコードを分析する際に自動的にこれを使用します
mcp__skim__skim_transform({
  source: 'function add(a, b) { return a + b; }',
  language: 'javascript',
  mode: 'structure',
  show_stats: true
})

// 返り値:
// function add(a, b)  { /* ... */ }
//
// 📊 Token Reduction Statistics:
// [skim] 24 tokens → 9 tokens (62.5% reduction)

ツール2: skim_file - ファイルの変換

ファイルまたはディレクトリを変換します。

mcp__skim__skim_file({
  path: '/workspace/src',
  mode: 'structure',
  show_stats: true
})

// 統計情報付きの圧縮コードを返します

ツール3: skim_analyze - アーキテクチャ分析

コードアーキテクチャを分析します。

mcp__skim__skim_analyze({
  path: '/workspace/src',
  mode: 'structure'
})

// 返り値:
// 1. 圧縮コード
// 2. トークン統計
// 3. Claudeをガイドする分析フレームワーク

高度な使用法

実際の使用例

シナリオ1: プロジェクトアーキテクチャの分析

あなた: "Help me analyze the code architecture in src/ directory"

Claude Code:
→ 自動的に mcp__skim__skim_analyze を呼び出します。
→ コードを圧縮します（トークン削減率65%）。
→ 迅速にアーキテクチャを分析し、提案を提供します。

結果: 完全なアーキテクチャ分析レポート

シナリオ2: コードレビュー

あなた: "Review the code quality of src/auth.ts"

Claude Code:
→ 自動的に mcp__skim__skim_file を呼び出します。
→ 関数シグネチャと重要なロジックを抽出します。
→ 詳細なコードレビュー提案を提供します。

結果: 潜在的な問題と改善提案を特定します。

シナリオ3: 大規模なファイルの理解

あなた: "What does this 3000-line file do?"

Claude Code:
→ 自動的に mcp__skim__skim_transform を呼び出します。
→ コア構造に圧縮します（内容削減率80%）。
→ 迅速に主要なロジックを理解します。

結果: 明確な機能概要とワークフローの説明

重要なポイント: これらのツールを手動で呼び出す必要はありません - Claude Codeが自動的に使用するタイミングを判断します！

🔧 技術詳細

セキュリティ機能

パス検証

✅ 絶対パスのみ許可されます。 ✅ パストラバーサル攻撃がブロックされます（../../../etc/passwd）。 ✅ シンボリックリンクの解決と検証が行われます。 ✅ 許可されたベースパスを設定可能です。

入力サニタイズ

✅ 最大入力サイズ（デフォルトで10MB）。 ✅ ヌルバイトの検出。 ✅ コマンドインジェクションの防止。 ✅ シェルインジェクションの軽減（パラメータ化されたコマンド）。

レート制限

✅ 1分あたりのリクエスト制限。 ✅ DoS攻撃の防止。 ✅ リトライ後のヘッダー。

テスト

テストの実行

# 依存関係をインストール
npm install

# すべてのテストを実行
npm test

# カバレッジ付きでテスト
npm run test:coverage

# 開発用のウォッチモード
npm run test:watch

テストカバレッジ

• ✅ Skim CLIの可用性
• ✅ パストラバーサルの防止
• ✅ 入力検証
• ✅ 超大入力の検出
• ✅ 無効な言語の検出
• ✅ ヌルバイトの拒否
• ✅ 不正なパスの処理

パフォーマンス

ベンチマーク

# 単一ファイル（300行）
skim transform - 1.3ms

# 大規模なファイル（3000行）
skim transform - 14.6ms

# キャッシュ済み（2回目の実行）
skim transform - 5ms (48倍高速)

# MCPのオーバーヘッド < 2ms

リソース制限

• 最大入力: リクエストあたり10MB
• 最大出力: 50MBバッファ
• タイムアウト: リクエストあたり30秒
• レート制限: 1分あたり10リクエスト

ドキュメント

変換モード

サポートされる言語

• TypeScript / JavaScript
• Python
• Rust
• Go
• Java
• JSON（特殊構造モード）
• Markdown（ヘッダー抽出）
• YAML / YML（構造抽出）

CLIリファレンス

# ファイルを変換
skim file.ts --mode=structure --show-stats

# ディレクトリを変換
skim src/ --mode=signatures

# グロブを使用して変換
skim 'src/**/*.ts' --jobs 4

# キャッシュをクリア
skim --clear-cache

開発

セットアップ

git clone https://github.com/luw2007/skim-mcp.git
cd skim-mcp
npm install

開発ワークフロー

# 開発を開始
npm run dev

# コードをリント
npm run lint

# リントの問題を修正
npm run lint:fix

# コードをフォーマット
npm run format:fix

# 本番環境用にビルド
npm run build

プロジェクト構造

skim-mcp/
├── src/
│   └── index.js          # メインサーバー
├── test/
│   └── index.test.js     # テストスイート
├── scripts/
│   ├── install-skim.js   # 自動インストールスクリプト
│   └── build.js          # ビルドスクリプト
├── docs/
│   └── examples.md       # 使用例
├── dist/                 # ビルド済みファイル
└── README.md

Docker

イメージのビルド

docker build -t skim-mcp .

コンテナの実行

docker run -i --rm \
  -e LOG_LEVEL=info \
  -v /workspace:/workspace \
  skim-mcp

Docker Compose

version: '3.8'
services:
  skim-mcp:
    image: skim-mcp
    environment:
      - LOG_LEVEL=info
      - SKIM_ALLOWED_PATHS=/workspace
    volumes:
      - ./workspace:/workspace

📄 ライセンス

MITライセンス - 詳細については LICENSE ファイルを参照してください。

🆘 サポート

問題の報告

問題は GitHub Issues で報告してください。

以下を含めてください。

• Node.jsのバージョン (node --version)
• OSとアーキテクチャ
• 再現手順
• エラーログ

ヘルプの取得

• 📖 ドキュメント: docs/
• 💡 例: docs/examples.md
• 💬 ディスカッション: GitHub Discussions

🔄 変更履歴

バージョン履歴については CHANGELOG.md を参照してください。

🔮 ロードマップ

v1.1.0（次のバージョン）

• [ ] HTTPトランスポートのサポート
• [ ] WebSocketトランスポート
• [ ] プラグインシステム
• [ ] カスタム変換ルール
• [ ] より多くのLLMプラットフォームとの統合

v1.2.0（将来のバージョン）

• [ ] 並列処理の最適化
• [ ] メモリ効率の高いストリーミング
• [ ] 高度なキャッシュ戦略
• [ ] メトリクスダッシュボード

🙏 謝辞

特別な感謝

Skim プロジェクトとその作者 @dean0x

このプロジェクトは、dean0xによって作成された優れたSkimプロジェクトをベースに構築されたMCPサーバーラッパーです。Skimは、Rustで書かれた強力なコード変換ツールで、LLM用のインテリジェントなコード圧縮機能を提供します。

• オリジナルプロジェクト: https://github.com/dean0x/skim
• コアテクノロジー: Rust + tree-sitter
• 貢献: 60 - 95%のコード圧縮機能を提供します。

dean0xの優れた仕事がなければ、このMCPサーバーは存在しないでしょう。技術的な詳細を学ぶために、オリジナルのプロジェクトを訪問することを強くお勧めします！

その他の謝辞

• Model Context Protocol - MCPプロトコル仕様
• tree-sitter - コード解析エンジン
• Claude Code チーム - 優れたAIコーディングアシスタントプラットフォームを提供してくれた
• このプロジェクトに貢献したすべての開発者

LLMコミュニティのために愛を込めて作られました