使用说明

项目简介

ValTown MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,它作为ValTown和LLM客户端(如Claude)之间的桥梁,使得AI助手能够安全地调用和执行ValTown平台上的函数和资源。通过这个服务器,LLM可以扩展其能力,利用ValTown强大的云端代码执行环境来完成更复杂的任务。

主要功能点

  • 代码执行: 允许AI助手通过调用预定义的工具,在ValTown环境中执行TypeScript代码。
  • ValTown功能集成: 集成了ValTown的多种功能,包括:
    • Val管理: 搜索、获取、创建、更新和删除ValTown中的Val(可以理解为云函数或代码片段)。
    • 项目管理: 列出、获取、创建和删除ValTown项目。
    • 分支管理: 列出、获取、创建和删除项目分支。
    • 文件管理: 列出、获取、创建、更新和删除项目文件和目录。
    • Blob存储: 列出、获取、存储和删除Blob对象(二进制大对象存储)。
    • SQLite数据库操作: 执行SQL查询和批量操作。
    • 用户信息查询: 获取用户信息和当前用户信息。
  • MCP协议兼容: 完全兼容MCP协议,可以与任何实现了MCP客户端的应用(如Claude Desktop, Claude Code等)无缝对接。
  • 跨平台支持: 支持Linux, macOS, Windows等多种操作系统。
  • 多种部署方式: 提供预编译二进制文件、源码编译和Deno直接运行等多种部署方式。

安装步骤

方法一:使用预编译二进制文件 (推荐)

  1. 访问 最新发布页面。(请注意,示例仓库的README.md中 'YOUR_USERNAME' 需要替换为实际的用户名。)
  2. 根据你的操作系统下载对应的二进制文件:
    • Linux: 'valtown-mcp-linux'
    • Windows: 'valtown-mcp-windows.exe'
    • macOS: 'valtown-mcp-macos'
  3. 将下载的文件移动到你希望安装的目录。
  4. (Linux/macOS)如果需要,为二进制文件添加执行权限:'chmod +x valtown-mcp-linux' 或 'chmod +x valtown-mcp-macos'。

方法二:从源代码构建

  1. 确保已安装 Deno
  2. 克隆此仓库到本地:'git clone https://github.com/PrashamTrivedi/valtown-mcp-server.git'
  3. 进入仓库目录:'cd valtown-mcp-server'
  4. 执行构建命令:'deno task build' (构建所有平台版本) 或 'deno task build:{platform}' (构建特定平台版本,如 'deno task build:linux')。
  5. 构建完成后,二进制文件将位于仓库目录中。

方法三:直接使用Deno运行

  1. 确保已安装 Deno
  2. 克隆此仓库到本地:'git clone https://github.com/PrashamTrivedi/valtown-mcp-server.git'
  3. 进入仓库目录:'cd valtown-mcp-server'
  4. 运行服务器:'deno task start' (启动服务器) 或 'deno task dev' (开发模式,带文件监视)。

服务器配置

环境变量配置

ValTown MCP服务器需要ValTown API Token才能访问ValTown API。你需要设置以下环境变量:

  • 'VAL_TOWN_API_TOKEN': 你的ValTown API Token (以 'vtwn_' 开头)。

你可以在你的 ValTown账户设置 中获取API Token。

MCP客户端配置 (以Claude Desktop为例)

在你的MCP客户端(例如Claude Desktop)的配置文件中,添加针对ValTown MCP服务器的配置。以下是不同运行方式的配置示例:

1. 运行预编译二进制文件 (Windows配置示例)

"valtown": {
  "command": "C:\\path\\to\\valtown-mcp-windows.exe",
  "env": {
    "VAL_TOWN_API_TOKEN": "vtwn_YOUR_API_TOKEN"
  }
}

2. 运行预编译二进制文件 (macOS配置示例)

"valtown": {
  "command": "/path/to/valtown-mcp-macos",
  "env": {
    "VAL_TOWN_API_TOKEN": "vtwn_YOUR_API_TOKEN"
  }
}

3. 运行预编译二进制文件 (Linux配置示例)

"valtown": {
  "command": "/path/to/valtown-mcp-linux",
  "env": {
    "VAL_TOWN_API_TOKEN": "vtwn_YOUR_API_TOKEN"
  }
}

4. 使用Deno直接运行 (所有平台通用配置)

"valtown": {
  "command": "deno",
  "args": ["run", "--allow-net", "--allow-env", "--allow-read", "/path/to/mod.ts"],
  "env": {
    "VAL_TOWN_API_TOKEN": "vtwn_YOUR_API_TOKEN"
  }
}

配置参数说明:

  • '"valtown"': 服务器名称,在客户端中用于标识和调用。
  • '"command"': 启动ValTown MCP服务器的可执行文件路径。
    • 对于预编译二进制文件,填写二进制文件的绝对路径。
    • 对于Deno运行,填写 'deno' 命令。
  • '"args"': 启动命令的参数,仅在 'command' 为 'deno' 时需要配置。
    • 'run': Deno的运行命令。
    • '--allow-net': 允许网络访问,ValTown MCP服务器需要访问ValTown API。
    • '--allow-env': 允许访问环境变量,用于读取 'VAL_TOWN_API_TOKEN'。
    • '--allow-read': 允许读取文件,可能用于读取配置文件或其他资源。
    • '/path/to/mod.ts': 'mod.ts' 文件的绝对路径,是ValTown MCP服务器的入口文件。 请根据实际文件路径修改。
  • '"env"': 环境变量配置。
    • '"VAL_TOWN_API_TOKEN"': ValTown API Token,请务必替换 'vtwn_YOUR_API_TOKEN' 为你实际的API Token

Claude Code 配置

你可以使用Claude Code CLI工具添加ValTown MCP服务器。以下是示例命令:

claude mcp add valtown /path/to/valtown-mcp-linux -e VAL_TOWN_API_TOKEN=vtwn_YOUR_API_TOKEN

请根据你的操作系统和二进制文件路径,以及实际的API Token,修改上述命令。

基本使用方法

  1. 启动服务器: 根据你的安装方式,启动ValTown MCP服务器。
  2. 配置MCP客户端: 将上述提供的JSON配置添加到你的MCP客户端配置文件中,或者使用客户端提供的添加MCP服务器的功能。
  3. 在LLM中使用工具: 在支持MCP协议的LLM应用中,你现在可以使用ValTown MCP服务器提供的工具了。例如,在Claude中,你可以指示Claude使用 'search-vals' 工具来搜索ValTown上的函数,或者使用 'create-val' 工具来创建一个新的ValTown函数。具体的工具名称和使用方法,可以参考代码仓库 'tools' 目录下的各个工具定义文件,以及工具的描述信息。

注意: 首次使用可能需要在ValTown平台创建账号并获取API Token。

信息

分类

AI与计算