使用说明
可视化代码服务器
Visual Code Server 是一个基于Python的项目,它使用 FastMCP 框架,用于从GitHub存储库中获取和可视化源代码。它提供了一个简单的界面来提取代码并生成其结构的视觉表示。
特性
- 从GitHub仓库获取源代码。
- 以可读格式可视化代码的结构。
- 使用
FastMCP以实现高效的服务器端处理。 - 异步HTTP请求由
httpx.
需求
- Python 3.11或更高版本
- 中列出的依赖关系
pyproject.toml和uv.lock
安装
-
克隆存储库:
git clone https://github.com/habibsifat/MCP-Server.git cd MCP-Server -
创建虚拟环境并激活它:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate -
安装依赖项:
pip install -r requirements.txt
用法
运行服务器
要开始 FastMCP 服务器,运行以下命令:
python visual.py
服务器将监听请求并处理GitHub URL以获取和可视化代码。
示例
要可视化GitHub存储库中的代码,请使用 visualize_code 工具:
# Example usage in Python
from visual import visualize_code
url = "https://github.com/user/repo/blob/main/file.py"
result = await visualize_code(url)
print(result)
运行主脚本
您还可以运行 main.py 脚本显示一个简单的问候语:
python main.py
项目结构
visual.py:获取和可视化代码的主服务器脚本。main.py:一个简单的入口点脚本。pyproject.toml:项目元数据和依赖关系。uv.lock:锁定依赖关系版本的文件。README.md:项目文件。
贡献
欢迎投稿!请随时打开问题或提交pull请求。
许可证
该项目根据MIT许可证获得许可。请参阅 LICENSE 文件以获取详细信息。
