MCP Server Tree Sitter

🚀 MCP Tree Structure (Tree) Guide

This guide offers a comprehensive introduction to the MCP Tree Structure, including installation, configuration, usage examples, and more. It helps users quickly get started with and master this tool.

🚀 Quick Start

Installation

1. Local Installation:

   pip install mcp-tree
   

2. Using a Virtual Environment:

   python -m venv myenv
   source myenv/bin/activate  # On Windows, use `myenv\Scripts\activate`
   pip install mcp-tree
   

Quick Hands - On

from mcp_tree import configure, get_container

# Configuration file path or pass parameters directly
configure(config_path="path/to/config.yaml")

container = get_container()

📦 Installation Guide

Configuration Examples

cache:
  enabled: true                # Enable/disable caching (Default: true)
  max_size_mb: 100            # Maximum cache size (MB) (Default: 100)
  ttl_seconds: 300            # Cache entry expiration time (seconds) (Default: 300)

security:
  max_file_size_mb: 5         # Maximum processed file size (MB) (Default: 5)
  excluded_dirs:              # Directories to exclude during processing
    - .git
    - node_modules
    - __pycache__
  allowed_extensions:          # Optional allowed file extensions
    - py
    - js

language:
  default_max_depth: 5        # Default maximum depth for AST traversal (Default: 5)
  preferred_languages:         # List of pre - loaded languages to speed up startup
    - python

Environment Variable Configuration

export MCP_TS_CACHE_MAX_SIZE_MB=256
export MCP_TS_LOG_LEVEL=DEBUG
export MCP_TS_CONFIG_PATH=/path/to/config.yaml

📚 Documentation

Log Settings

Log Levels:

• DEBUG
• INFO
• WARNING
• ERROR

Default Path: ~/.config/tree-sitter/config.yaml

Resources and Tools

Provided Resources

1. Project - Related Resources:

   • project://{project}/files: List all files in the project.
   • project://{project}/files/{pattern}: List files by pattern matching.
   • project://{project}/file/{path}: Get the content of the file at the specified path.
   • project://{project}/ast/{path}: Get the AST structure of the file.

2. Language - Related Resources:

   • language: Pre - load commonly used languages to improve performance.

Provided Tools

1. Project Management Tools:

   • register_project_tool
   • list_projects_tool
   • remove_project_tool

2. File Operation Tools:

   • list_files
   • get_file
   • get_file_metadata

3. AST Analysis Tools:

   • get_ast
   • get_node_at_position

4. Code Search and Query:

   • find_text
   • run_query
   • build_query
   • adapt_query

5. Symbol Extraction and Analysis:

   • get_symbols
   • find_usage

💡 Usage Tip

1. Code Review: Used to generate code review reports.
2. Error Location: Helps quickly locate code problems.
3. Dependency Injection: Manages dependencies in the project.

For more detailed information, please refer to the official documentation.