Vantage MCP Server

Vantage MCP服务器

Use natural language to explore your organization's cloud costs via MCP clients, like Claude, Cursor, and others. Ask questions about your organization's previous and current cloud cost spend, cost tagging, provider integrations, and more.

关于Vantage MCP服务器

此存储库支持Vantage MCP服务器的两种不同部署模式：

• 自托管（本地）模式：通过 src/local.ts

- 使用在本地运行 标准输入/输出（stdio）传输 - 与MCP客户端直接通信 - 需要Vantage API代币 - 最适合个人用户、开发人员或您想要完全控制的时候

• 远程（HTTP）模式：通过 src/cf-worker.ts

- 作为一个 Cloudflare工作人员 使用HTTP端点 - 支持多种身份验证方法（OAuth、API令牌、Vantage头） - 可通过网络请求访问 - 最适合团队、生产部署或需要基于web的访问

> 📝 _注意：要在非开发工作流中使用远程HTTP版本，请参阅 Vantage MCP文档._

可用工具

Vantage MCP Server提供了一组用于列出、查询和创建Vantage资源的工具。这些工具可以由任何兼容的MCP客户端调用，并且可以在 /src/工具.

开始使用

先决条件

• 和 安装
• 访问MCP兼容客户端（如Claude Desktop、Cursor或Goose）
• A. Vantage账户 至少有一个 连接提供商 （AWS、Azure、谷歌云等）

安装

1. 克隆此仓库并安装依赖项：

   git clone https://github.com/vantage-sh/vantage-mcp-server
   cd vantage-mcp-server
   npm install

1. 按照创建Vantage API令牌 Vantage文档.

运行MCP服务器：自托管（本地）模式

📝 _注意：这种自托管模式旨在开发和贡献MCP服务器。对于个人使用，建议使用 npx -y vantage-mcp-server._

要使用自托管MCP服务器，您需要配置MCP客户端以启动服务器。配置过程因您使用的MCP客户端而异。示例客户包括：

• Claude桌面版
• 光标
• 鹅

请参阅 MCP文件 查看可用客户端列表。下面提供了Claude桌面、光标和鹅的详细说明。

Claude桌面版

1. 下载 Claude桌面版.
2. 从Claude for Desktop的顶部，单击 克劳德>设置 （键盘快捷键 Command + ,).
3. 在“设置”窗格的左侧菜单中，选择 开发者.
4. 点击 编辑配置配置文件在以下位置创建：

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• 视窗: %APPDATA%\Claude\claude_desktop_config.json

1. 打开 claude_desktop_config.json 文件并更新其内容。替换占位符 `

使用克隆此存储库的路径，以及 ` 使用Vantage API代币。

   {
     "mcpServers": {
       "Vantage": {
         "command": "npx",
         "args": ["tsx", "
/src/local.ts"],
         "env": { "VANTAGE_TOKEN": "
" }
       }
     }
   }

> 📝 _注意：服务器使用 tsx 直接运行TypeScript。如果你有 tsx 全局安装，您可以使用 "command": "tsx" 和 "args": [" /src/local.ts"] 相反。_

1. 保存配置文件并重新启动Claude。

1. 在Claude for Desktop输入框的左角，单击 搜索和工具 图标，查看Vantage MCP服务器的可用工具。

1. 设置配置后，您可以开始提示Claude。每次使用新工具时，Claude都会在继续之前征求您的批准。

光标

1. 下载 光标.

1. 打开光标并单击 光标>设置>光标设置 从菜单栏。

1. 在左侧窗格中，选择 工具和MCP.

1. 点击 新建MCP服务器.

1. 更新打开的内容 mcp.json 文件。确保替换占位符 `

使用克隆此存储库的路径，以及 ` 使用Vantage API代币。

   {
     "mcpServers": {
       "Vantage": {
         "command": "npx",
         "args": ["tsx", "
/src/local.ts"],
         "env": { "VANTAGE_TOKEN": "
" }
       }
     }
   }

> 📝 _注意：服务器使用 tsx 直接运行TypeScript。如果你有 tsx 全局安装，您可以使用 "command": "tsx" 和 "args": [" /src/local.ts"] 相反。_

1. 保存配置文件。

1. 您将看到Vantage MCP服务器中启用了工具 已安装的MCP服务器 列表。

鹅

1. 下载 鹅.
2. 打开鹅。在左侧导航中，选择 扩展.
3. 点击 添加自定义扩展名.
4. 在 扩展名 字段，输入 Vantage.
5. 对于 类型，选择 工作室.
6. 在 描述 字段，输入 Query costs and usage data.
7. 在 命令 字段，输入 `npx tsx

/src/local.ts （替换 ` 使用克隆存储库的实际路径）。

1. 在 环境变量 节中，添加一个名为的新变量 VANTAGE_TOKEN 以及为Vantage API代币设置的值。在环境变量旁边，单击 添加.
2. 点击 添加扩展名.

本地开发：运行HTTP模式

要在本地开发和测试HTTP/Cloudflare Worker模式，您可以使用 npm run dev。这将使用Wrangler启动本地开发服务器。

绕过OAuth进行本地开发

为了便于本地开发，您可以配置 VANTAGE_MCP_TOKEN 环境变量 wrangler-DEV.jsonc 绕过OAuth身份验证。设置后，服务器将直接使用此令牌，而不需要OAuth流。

1. 打开 wrangler-DEV.jsonc 并设置 VANTAGE_MCP_TOKEN 价值在 vars 章节：

   {
     "vars": {
       "VANTAGE_MCP_TOKEN": "your_vantage_api_token_here",
       // ... other vars
     }
   }

1. 运行开发服务器：

   npm run dev

1. 服务器将在以下时间可用 http://localhost:8787 （Wrangler的默认端口，如中配置的 wrangler-DEV.jsonc)并将绕过OAuth，使用 VANTAGE_MCP_TOKEN 用于身份验证。

📝 _注：设置 VANTAGE_MCP_TOKEN 启用直接令牌模式，该模式完全绕过OAuth。这对于本地开发或没有OAuth支持或传递标头能力的MCP客户端非常有用。_

本地开发：添加新工具

要向应用程序添加新工具，请在以下位置创建一个文件 src/tools/.ts，并使用以下结构：

import registerTool from "./structure/registerTool";
import MCPUserError from "./structure/MCPUserError";
import z from "zod";

const description = `
Your description here.
`.trim();

const args = {
    exampleArg: z.string(),
};

export default registerTool({
    name: "my-tool-name", // replace with the tool name
    description,
    async execute(args, ctx) {
        // args will be a resolved version of the schema
        console.log(args);

        if (args.exampleArg === "something") {
            // We throw a MCPUserError to send a message to the user
            // The argument is the body
            throw new MCPUserError({ my: "error" });
        }

        // ctx is a ToolCallContext, this has the function to call the vantage api

        // Then we just return
        return { a: "b" };
    },
});

_重要提示： 添加或删除工具时，运行 npm run generate-tools-index 更新工具索引。_

可用脚本

• npm run dev -使用Wrangler DEV配置启动开发服务器
• npm run local -运行本地stdio MCP服务器（使用tsx支持TypeScript）
• npm run --silent local -以减少的输出运行本地MCP服务器（建议用于开发）
• npm run inspect -启动MCP检查器工具
• npm run format -使用Biome格式化代码
• npm run lint:fix -Lint和自动修复Biome的问题
• npm run type-check -运行TypeScript类型检查
• npm run cf-typegen -生成Cloudflare Worker类型
• npm run generate-tools-index -添加/删除工具后生成工具索引

公共资产

这 /public 文件夹可公开访问。任何类似的文件 /public/asset.gif 可访问为 /asset.gif 在本地或Cloudflare上运行时。

贡献指南

如果你想为这个项目做出贡献：

1. 分叉此存储库。
2. 创建新分支： git checkout -b feature/my-feature.
3. 进行更改。
4. 确保你的代码格式清晰，构建清晰：

   npm run format
   npm run lint:fix
   npm run type-check

1. 提交a 拉取请求.

我们欢迎社区贡献、改进和bug修复。

许可证

请参阅 LICENSE.md 商业和非商业许可详细信息文件。