Glyph

🚀 glyph

「glyph」は、Tree - sitterの宣言的クエリ言語を使用してコードベースからシンボルアウトラインを抽出するモデルコンテキストプロトコル（MCP）サーバーです。クリーンで効率的なシンボル抽出により、LLMコーディングエージェントに必要なコンテキストを提供します。また、スタンドアロンのCLIツールとしても使用できます。

🚀 クイックスタート

「glyph」は、ファイルパスのグロブを受け取り、一致するコードファイルを再帰的に探索し、Tree - sitterの強力なクエリ言語を使用して解析し、正確なシンボルアウトラインを生成します。ユーザーは、高レベルの構造から可視性修飾子付きの完全な関数シグネチャまで、詳細レベルをコントロールできます。

✨ 主な機能

• 宣言的クエリベースの抽出 - Tree - sitterのクエリ言語を使用して、正確で保守性の高いシンボル抽出を行います。
• グロブベースのファイル探索 - 慣れ親しんだパターンでコードを指定できます。
• 言語非依存のアーキテクチャ - クエリパターンを追加するだけで、新しい言語を簡単にサポートできます。
• 詳細レベルの設定可能 - 必要なコンテキストの量を選択できます。
• マルチファイルサポート - プロジェクト全体の統一されたビューを取得できます。
• MCPネイティブ - AIコーディングワークフローとのシームレスな統合のために構築されています。
• 高性能 - 高速抽出のために最適化されたTree - sitterクエリを使用しています。

📦 インストール

macOS

Goをインストールします：

$ brew install go

最新バージョンの「glyph」をインストールします：

$ GOBIN=/usr/local/bin go install "github.com/benmyles/glyph@latest"

📚 ドキュメント

なぜ「glyph」を使うのか？

LLMコーディングエージェントは、コードの構造を理解しているときに最も効果的に機能します。「glyph」は、クリーンなマルチファイルシンボルマップを提供することで、トークン制限を超えることなく効率的なコンテキストを提供し、そのギャップを埋めます。

サポートされている言語

• Go - 関数、メソッド、型、構造体、インターフェース、定数、変数
• Java - クラス、インターフェース、メソッド、コンストラクタ、フィールド、列挙型、レコード、アノテーション
• JavaScript/TypeScript - 関数、クラス、メソッド、アロー関数、変数、インターフェース、型エイリアス
• Python - 関数、クラス、デコレートされた定義、代入
• 拡張が容易 - 新しい言語を追加するには、約20行のクエリパターンが必要です。

アーキテクチャ

「glyph」は、現代的な宣言的アプローチを使用しています：

• Tree - sitterクエリが複雑なASTトラバーサルロジックを置き換えます。
• 言語固有のクエリパターンが抽出するシンボルを定義します。
• 統一された抽出エンジンがすべての言語で動作します。
• モジュール型設計で、クエリ、抽出、フォーマット、ファイル処理がそれぞれ独立しています。

シンボルタイプ

「glyph」は、トークンの使用を最小限に抑えるために、簡潔なシンボルタイプ名を使用します：

• func - 関数および関数のような宣言
• method - クラス/構造体のメソッド
• class - クラス
• interface - インターフェース
• struct - 構造体（Go）
• type - 型宣言（Go）
• const - 定数
• var - 変数
• field - クラス/構造体のフィールド
• constructor - コンストラクタ
• enum - 列挙型
• record - レコード（Java）
• annotation - アノテーション（Java）
• property - プロパティ（TypeScript）

詳細レベル

最小限

シンボル名と型、行番号のみを表示します：

- func: main (line 15)
- struct: Server (line 5)
- method: Start (line 10)

標準（デフォルト）

シグネチャと宣言を表示します：

- func: func main()
- struct: type Server struct
- method: func (s *Server) Start() error

完全

コードブロック付きの完全なシンボル定義を表示します：

- func (lines 15 - 20):

func main() { server := &Server{} server.Start() }

開発

$ git clone https://github.com/benmyles/glyph
$ cd glyph

$ make clean

$ make test

$ make build

$ make install DESTDIR=/usr/local/bin

新しい言語の追加

クエリベースのアーキテクチャのおかげで、新しい言語のサポートを追加するのは簡単です：

1. file_utils.goで言語検出を追加します（約2行）
2. queries.goでクエリパターンを追加します（約10 - 20行）
3. queries.goでクエリディスパッチャに追加します（約5行）

Rustのサポートを追加する例：

// In file_utils.go
case ".rs":
    return rust.GetLanguage(), nil

// In queries.go
var rustQueries = map[string]string{
    "functions": `
        (function_item
            name: (identifier) @name
        ) @function
    `,
    "structs": `
        (struct_item
            name: (type_identifier) @name
        ) @struct
    `,
    // ... more patterns
}

パフォーマンス

• Tree - sitterのインクリメンタルパースによる高速パース
• 効率的なシンボル抽出のための最適化されたクエリ
• ストリーミングファイル処理による最小限のメモリ使用
• 複数のファイルでのパフォーマンス向上のためのパーサーの再利用

💻 使用例

AIコーディングアシスタントとの統合

Claude Code

MCPコマンドを使用して「glyph」をClaude Codeに追加します：

# 「glyph」をローカルMCPサーバーとして追加（現在のプロジェクト用）
claude mcp add glyph /usr/local/bin/glyph mcp

インストールを確認するには：

# すべての構成済みサーバーをリストする
claude mcp list

# 「glyph」サーバーの詳細を確認する
claude mcp get glyph

Claude Code内でいつでも/mcpコマンドを使用してサーバーの状態を確認できます。

Cursor

「glyph」をCursorのMCP構成に追加します：

1. Cursorの設定を開きます（Cmd/Ctrl + ,）
2. 「MCP」を検索するか、拡張機能 → MCPに移動します
3. 「glyph」をMCPサーバーに追加します：

{
  "mcpServers": {
    "glyph": {
      "command": "/usr/local/bin/glyph",
      "args": ["mcp"]
    }
  }
}

構成後、MCPインターフェースを通じて「glyph」を使用して、コードベースからシンボルアウトラインを抽出し、AIがコード構造をよりよく理解できるようにすることができます。

MCPサーバーモード（デフォルト）

「glyph」をMCPサーバーとして実行して、LLMコーディングエージェントと統合します：

$ glyph mcp

CLIモード

コマンドラインから直接「glyph」を使用してシンボルを抽出します：

$ glyph cli '/path/to/project/*.go'

$ glyph cli -detail=minimal '/path/to/project/**/*.js'

オプション:

• -detail：詳細レベル（minimal、standard、またはfull）。デフォルトはstandardです。

注: すべてのファイルパターンは絶対パスで指定する必要があります。