使用说明
项目简介
PineScript MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,专注于为大型语言模型(LLM)客户端提供关于 TradingView PineScript 脚本的上下文信息和功能。它提供了一系列工具,用于验证 PineScript 代码的语法正确性,自动修复常见的错误,并生成预定义的 PineScript 代码模版。此服务器旨在简化 PineScript 代码的开发和维护流程,尤其是在 LLM 需要理解或生成 PineScript 代码的场景中。
主要功能点
- PineScript 代码校验: 提供 'validate_pinescript' 工具,能够检测 PineScript 代码中的语法错误和警告,帮助开发者确保代码的质量和准确性。
- 自动错误修复: 提供 'fix_pinescript_errors' 工具,可以自动修正 PineScript 代码中常见的语法错误,例如括号不匹配、引号未闭合、缺少逗号等,提高开发效率。
- PineScript 模版生成: 提供 'get_pinescript_template' 工具,支持生成预定义的 PineScript 策略和指标模版,例如移动平均交叉策略、RSI 指标、MACD 指标等,方便用户快速开始 PineScript 脚本的编写。
- 版本管理: 提供 'convert_pinescript_version', 'save_pinescript_version', 'get_pinescript_history', 'compare_pinescript_versions' 等工具,支持 PineScript 代码的版本转换、历史记录保存和版本比较功能。
- 代码格式化: 提供 'format_pinescript' 工具,可以根据最佳实践格式化 PineScript 代码,提高代码可读性和一致性。
- 配置管理: 提供 'get_pinescript_config', 'update_pinescript_config', 'reset_pinescript_config', 'get_config_section', 'set_templates_directory' 等工具,允许用户自定义服务器配置,例如模版目录、验证规则等。
安装步骤
-
克隆仓库
git clone https://github.com/CyberBOB07/pinescript-mcp-server.git cd pinescript-mcp-server -
安装依赖 确保你的环境中已安装 Node.js (16.x 或更高版本) 和 npm (8.x 或更高版本)。
npm install -
构建项目
npm run build
服务器配置
为了让 MCP 客户端能够连接到 PineScript MCP Server,你需要配置客户端的服务器连接信息。以下是一个 JSON 格式的配置示例,你需要将其添加到你的 MCP 客户端配置中。
{ "serverName": "pinescript-mcp-server", "command": "npm", "args": [ "run", "start-server" ], "transport": "stdio", "timeout": 300000, "description": "PineScript MCP Server 提供 PineScript 代码校验、修复和模版生成等功能。" }
配置参数注释:
- 'serverName': 服务器的名称,可以自定义,用于在客户端标识此服务器连接。
- 'command': 启动服务器的命令,这里使用 'npm' 命令。
- 'args': 启动命令的参数,'run start-server' 会执行 'package.json' 中定义的 'start-server' 脚本,启动 PineScript MCP Server。
- 'transport': 指定 MCP 客户端与服务器之间的通信方式,这里使用 'stdio' (标准输入输出)。
- 'timeout': 请求超时时间,单位为毫秒。设置为 '300000' (5 分钟) 可以避免因PineScript脚本处理耗时过长而导致的超时错误。
- 'description': 服务器的描述信息,用于在客户端界面展示,帮助用户了解服务器的功能。
基本使用方法
-
启动服务器 在仓库根目录下运行以下命令启动 PineScript MCP Server:
npm run start-server服务器将通过 stdio 传输协议等待客户端连接和请求。
-
配置 MCP 客户端 根据你的 MCP 客户端软件的使用说明,配置服务器连接,填入上面提供的 JSON 配置信息。
-
使用 MCP 客户端功能 连接成功后,你就可以在 MCP 客户端中使用 PineScript MCP Server 提供的各种工具了。例如:
- 使用 'validate_pinescript' 工具校验 PineScript 代码。
- 使用 'fix_pinescript_errors' 工具修复代码错误。
- 使用 'get_pinescript_template' 工具获取 PineScript 模版。
- ... 等等。
具体工具的使用方法和参数,请参考 “API” 章节的工具描述信息。
信息
分类
开发者工具