项目介绍
GLSL 文档 MCP 服务器
一个全面的 MCP 服务器,用于与 React Three Fiber 结合的 GLSL 着色器开发。
特性
- GLSL 基础知识:《着色器之书》、OpenGL.org、Khronos OpenGL
- R3F 实现:Maxime Heckel 指南、Shadertoy 转换、Codrops 效果
- 粒子系统:GPU 粒子、FBO 技术、基于曲线的效果
安装
预备条件
- Python 3.10+
- Claude Code 或 Claude Desktop
设置
git clone https://github.com/yourusername/glsl-docs-mcp.git
cd glsl-docs-mcp
python -m venv .venv
source .venv/bin/activate # 在 Windows 上:.venv\Scripts\activate
pip install -r requirements.txt
配置
对于 Claude Code,添加到 ~/.claude.json:
{
"mcpServers": {
"glsl_docs": {
"command": "/path/to/glsl-docs-mcp/run_server.sh",
"args": []
}
}
}
对于 Claude Desktop,添加到配置文件中:
{
"mcpServers": {
"glsl_docs": {
"command": "python",
"args": ["/path/to/glsl-docs-mcp/server.py"]
}
}
}
使用方法
search_glsl_fundamentals("uniforms") - GLSL 基础知识和理论
search_r3f_shader_setup("shaderMaterial") - R3F 实现
search_particle_shaders("gpu particles") - 粒子系统
search_threejs_material_modification("onBeforeCompile") - 高级材质修补
get_all_shader_resources() - 完整资源列表
文档来源
GLSL 基础知识
- 《着色器之书》 - https://thebookofshaders.com/
- OpenGL.org - https://www.opengl.org/
- Khronos OpenGL - https://www.khronos.org/opengl/
- WebGL 基础知识 - https://webglfundamentals.org/webgl/lessons/webgl-shaders-and-glsl.html
- Three.js 手册 - 着色器 - https://threejs.org/manual/#en/shaders
R3F 实现
- Maxime Heckel R3F 指南 - 完整的着色器设置教程
- TheFrontDev Shadertoy 到 R3F - 转换工作流程
- Three.js 手册 - Shadertoy - https://threejs.org/manual/#en/shadertoy
- Codrops Reveal 效果 - 实用着色器效果
粒子系统
- TheFrontDev GPU 粒子 - 粒子基础知识
- Maxime Heckel 高级粒子 - FBO 技术
- TheFrontDev 曲线粒子 - 尾迹效果
高级 Three.js 材质修改
- Dusan Bosnjak - 使用 GLSL 扩展材质 - 最终的 onBeforeCompile 指南
1
- Three.js 旅程 - 修改过的材质 - 全面的材质修改课程
- Codrops - 魔法弹珠 - 实用的 onBeforeCompile 示例
- Three.js ShaderChunk 源码 - 所有着色器片段定义
- Three.js ShaderLib 源码 - 内置材质着色器程序
- Three.js UniformsLib 源码 - 均匀变量定义
- Three.js UniformsUtils 文档 - 均匀变量工具 API
- 官方修改过的材质示例 - 实时演示
总计:22 个全面的文档来源
贡献
要添加新的文档来源:
- 在
server.py 的 DOCS_SITES 中添加站点
- 创建或更新相关的搜索函数
- 测试新内容
- 提交拉取请求
许可证
MIT 许可证