mcp-server-tree-sitter

🚀 MCP 树结构（Tree）指南

本指南主要介绍了 MCP 树结构（Tree）的安装、配置、使用等内容，帮助你快速上手并高效使用该工具。

🚀 快速开始

在开始使用 MCP 树结构（Tree）前，你需要进行安装与配置。以下是快速上手的示例代码：

from mcp_tree import configure, get_container

# 配置文件路径或直接传递参数
configure(config_path="path/to/config.yaml")

container = get_container()

📦 安装指南

本地安装

pip install mcp-tree

虚拟环境使用

python -m venv myenv
source myenv/bin/activate  # 在 Windows 上使用 `myenv\Scripts\activate`
pip install mcp-tree

💻 使用示例

基础用法

以下是一个简单的配置示例，展示了如何配置缓存、安全、语言等相关参数：

cache:
  enabled: true                # 启用/禁用缓存（默认：true）
  max_size_mb: 100            # 最大缓存大小（MB）（默认：100）
  ttl_seconds: 300            # 缓存条目过期时间（秒）（默认：300）

security:
  max_file_size_mb: 5         # 最大处理文件大小（MB）（默认：5）
  excluded_dirs:              # 处理中要排除的目录
    - .git
    - node_modules
    - __pycache__
  allowed_extensions:          # 可选允许的文件扩展名
    - py
    - js

language:
  default_max_depth: 5        # 默认 AST 遍历最大深度（默认：5）
  preferred_languages:         # 加速启动预加载语言列表
    - python

高级用法

你还可以通过环境变量进行配置，示例如下：

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

📚 详细文档

日志设置

日志级别包括：

• DEBUG
• INFO
• WARNING
• ERROR 默认路径为：~/.config/tree-sitter/config.yaml

资源与工具

提供的资源

• 项目相关资源：
  • project://{project}/files：列出项目中所有文件
  • project://{project}/files/{pattern}：按模式匹配列出文件
  • project://{project}/file/{path}：获取指定路径下的文件内容
  • project://{project}/ast/{path}：获取文件的 AST 结构
• 语言相关资源：
  • language：预加载常用语言以提升性能

提供的工具

• 项目管理工具：
  • register_project_tool
  • list_projects_tool
  • remove_project_tool
• 文件操作工具：
  • list_files
  • get_file
  • get_file_metadata
• AST 分析工具：
  • get_ast
  • get_node_at_position
• 代码搜索与查询：
  • find_text
  • run_query
  • build_query
  • adapt_query
• 符号提取与分析：
  • get_symbols
  • find_usage

提示语

• 代码审查：用于生成代码审查报告
• 错误定位：帮助快速定位代码问题
• 依赖注入：管理项目中的依赖关系

更多详细信息请参考官方文档。