io.github.carsxe/carsxe-mcp

编码与调试

by carsxe

用于 CarsXE 车辆数据的 MCP 服务器,可查询 VIN、参数规格、历史记录、图片、recall 与 OBD code。

什么是 io.github.carsxe/carsxe-mcp

用于 CarsXE 车辆数据的 MCP 服务器,可查询 VIN、参数规格、历史记录、图片、recall 与 OBD code。

README

🚗 CarsXE MCP Server

A modular, extensible Model Context Protocol (MCP) server for querying and analyzing vehicle data from the CarsXE API, with beautiful, chat-friendly Markdown output for LLMs and chatbots.


ℹ️ What is CarsXE MCP Server?

The CarsXE MCP server is a Node.js/TypeScript application that exposes a suite of tools for querying comprehensive vehicle data from the CarsXE API. It is designed for seamless integration with LLMs (like Anthropic Claude, OpenAI GPT, etc.), chatbots, and developer tools, providing:

  • 🧩 Clean, modular code for each CarsXE endpoint
  • 📝 Consistent, Markdown-rich output for chat/LLM environments
  • 🛡️ Robust error handling and user-friendly messages
  • 🔌 Easy extensibility for new endpoints and features

💡 Why Use CarsXE with MCP?

Connecting CarsXE to your AI editor or chat client via MCP gives you a supercharged vehicle data experience — directly inside the tools you already use:

BenefitDescription
Ask in plain EnglishNo need to know API endpoints or parameters — just describe what you want
Context-aware answersThe AI combines live vehicle data with your question for tailored, actionable responses
No tab switchingGet VIN specs, history, recalls, and values without leaving your editor or chat
Chain requests effortlesslyDecode a plate → get full specs → check recalls → get market value, all in one conversation
Always live dataEvery query hits the CarsXE API in real time — no stale cache or outdated results
Works in your favorite editorClaude Desktop, Cursor, VS Code, Windsurf, and any MCP-compatible client

✨ Features

  • 🤖 Uses Anthropic Claude to generate comprehensive, professional answers based on the API data and user query
  • 🚙 Query vehicle specs, history, images, recalls, market value, and more
  • 🏷️ Decode license plates and VINs (including OCR from images)
  • 🛠️ Decode OBD (On-Board Diagnostics) codes
  • 🎨 All endpoints return elegant, grouped, emoji-rich Markdown
  • 🧑‍💻 Modular code: types, API logic, and formatters are separated for maintainability
  • 🧪 Simple to run, test, and extend

⚙️ Prerequisites

CarsXE API key (get one here)


🖥️ Installation by Editor

All editors use the same remote MCP endpoint. Replace YOUR_API_KEY with your actual CarsXE API key in every config below.


Claude Desktop

1️⃣ Download and Install Claude Desktop

  • Go to the official Claude Desktop download page
  • Download the installer for your operating system (macOS, Windows, or Linux)
  • Install Claude Desktop by following the on-screen instructions

2️⃣ Configure Claude Desktop to Use the CarsXE MCP Server

a. Open Claude Desktop Settings

  • Launch the Claude Desktop app
  • Click on Claude in the menu bar
  • Select Settings
  • In the Settings window, go to the Developer tab (you may need to scroll or expand advanced options)
  • Click Edit Config (or Open Config File)

b. Edit the Configuration File

  • This will open the claude_desktop_config.json file in your default text editor.

  • Locate the "mcpServers" section. If it does not exist, add it as shown below.

  • Add or update the following entry for CarsXE:

    json
    "mcpServers": {
      "carsxe": {
        "command": "npx",
        "args": [
          "mcp-remote@latest",
          "https://mcp.carsxe.com/mcp",
          "--header",
          "X-API-Key: YOUR_API_KEY"
        ]
      }
    },
    
  • Replace YOUR_API_KEY with your actual CarsXE API Key

  • Tip: You can add multiple MCP servers under "mcpServers" if you use more than one.

  • Save the configuration file and close your editor.

c. Restart Claude Desktop

  • Close and reopen the Claude Desktop app to apply the new configuration.

    It may take a short delay for the changes to take effect.

3️⃣ Verify the CarsXE MCP Server is Available

  • After restarting, open Claude Desktop.
  • Go to the tools or plugins section (usually in the search bar or under a tools menu).
  • You should see CarsXE listed as an available MCP server/tool.
  • Try running a CarsXE tool (e.g., get_vehicle_specs) to verify everything is working.

    This will only work if your API key is associated with an active subscription.


Cursor

Install CarsXE MCP for Cursor

The install dialog will open pre-filled with:

FieldValue
NameCarsXE
TypestreamableHttp
URLhttps://mcp.carsxe.com/mcp
HeaderX-API-Key: YOUR_API_KEY

Replace YOUR_API_KEY with your actual CarsXE API key, then click Install.


Visual Studio Code (GitHub Copilot)

Install CarsXE MCP for VS Code

After clicking install, you'll need to add your API key manually:

  1. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Run MCP: List Servers
  3. Find CarsXE in the list and click on it
  4. Click Show Configuration
  5. Replace YOUR_API_KEY with your actual CarsXE API key:
json
   "CarsXE": {
     "type": "http",
     "url": "https://mcp.carsxe.com/mcp",
     "headers": {
       "X-API-Key": "YOUR_ACTUAL_KEY_HERE"
     }
   }
  1. Save the file — VS Code will connect automatically.

Note: Make sure you have the GitHub Copilot extension installed and agent mode enabled (chat.agent.enabled in VS Code settings).


Windsurf

1️⃣ Open MCP Configuration

  • Go to Windsurf SettingsMCP (or press Ctrl+, and search for MCP)
  • Click "Edit Config" to open ~/.codeium/windsurf/mcp_config.json

2️⃣ Add the CarsXE Server

json
{
  "mcpServers": {
    "carsxe": {
      "command": "npx",
      "args": [
        "mcp-remote@latest",
        "https://mcp.carsxe.com/mcp",
        "--header",
        "X-API-Key: YOUR_API_KEY"
      ]
    }
  }
}

3️⃣ Restart Windsurf

Reload the window or restart Windsurf. Open the Cascade chat panel — CarsXE tools will appear automatically.


Other Editors (Manual / Generic)

For any other MCP-compatible client, register a remote MCP server using:

  • Endpoint: https://mcp.carsxe.com/mcp
  • Transport: HTTP (Streamable HTTP)
  • Auth header: X-API-Key: YOUR_API_KEY

Consult your editor's MCP documentation for the exact configuration format.


🛠️ Available Tools & Example Prompts

Below is a list of all available CarsXE tools, their parameters, and example prompts. These prompts work in any MCP-connected client.

1. get_vehicle_specs 🚙

  • Description: Get comprehensive vehicle specifications by VIN

  • Parameters:

    • vin (string, required): 17-character Vehicle Identification Number
  • Example Prompts:

    What are the full specs for VIN WBAFR7C57CC811956?

    Is this a V6 or V8? VIN: WBAFR7C57CC811956

    What trim level is WBAFR7C57CC811956?

  • Output: Markdown-formatted vehicle specs (year, make, model, engine, dimensions, colors, equipment, etc.)


2. decode_license_plate 🏷️

  • Description: Decode a vehicle's license plate to get VIN and basic info

  • Parameters:

    • plate (string, required): License plate number
    • state (string, optional): State abbreviation (e.g., CA)
    • country (string, required, default: US): Country code
  • Example Prompts:

    What car has license plate 7XER187 in California?

    Decode plate 7XER187 state CA

    Look up the plate ABC1234 in Texas

  • Output: Markdown summary of decoded vehicle info (VIN, make, model, year, etc.)


3. decode_international_vin 🌍

  • Description: Decode an international VIN for detailed info

  • Parameters:

    • vin (string, required): 17-character VIN
  • Example Prompts:

    Decode this European VIN: WF0MXXGBWM8R43240

    What car is WAUZZZ8K9AA123456? It's a German VIN.

  • Output: Markdown with international vehicle details (manufacturer, specs, emissions, etc.)


4. get_market_value 💰

  • Description: Get estimated market value for a vehicle by VIN

  • Parameters:

    • vin (string, required): 17-character VIN
    • state (string, optional): US state abbreviation
    • mileage (number, optional): Current mileage of the vehicle to adjust the market value
    • condition (string, optional): Overall condition of the vehicle — excellent, clean, average, or rough
  • Example Prompts:

    How much is WBAFR7C57CC811956 worth?

    I'm thinking of buying VIN WBAFR7C57CC811956 — what's a fair price?

    What's the trade-in value for WBAFR7C57CC811956 in Florida with 45,000 miles in clean condition?

  • Output: Markdown with market value breakdown (retail, trade-in, MSRP, etc.)


5. get_vehicle_history 🕓

  • Description: Get a comprehensive vehicle history report by VIN

  • Parameters:

    • vin (string, required): 17-character VIN
    • format (string, optional): Response format (json or xml)
  • Example Prompts:

    Has WBAFR7C57CC811956 ever been in an accident?

    Show me the full history for VIN WBAFR7C57CC811956

    How many owners has WBAFR7C57CC811956 had?

  • Output: Markdown with history records (junk/salvage, insurance, brands, titles, odometer, etc.)


6. get_vehicle_images 🖼️

  • Description: Get vehicle images by make, model, and filters

  • Parameters:

    • make (string, required)
    • model (string, required)
    • year, trim, color, transparent, angle, photoType, size, license, format (all optional)
  • Example Prompts:

    Show me photos of a blue 2018 Toyota Tacoma

    Get images of a red 2022 Ford Mustang GT

    What does a white 2020 Tesla Model 3 look like?

  • Output: Markdown with up to 5 images (links, thumbnails, details)


7. get_vehicle_recalls 🚨

  • Description: Get vehicle recall information by VIN

  • Parameters:

    • vin (string, required): 17-character VIN
  • Example Prompts:

    Does 1C4JJXR64PW696340 have any open recalls?

    I just bought VIN 1C4JJXR64PW696340 — should I be worried about recalls?

    Check for safety recalls on WBAFR7C57CC811956

  • Output: Markdown with recall details (date, description, risk, remedy, status, etc.)


8. read_license_plate_from_image 🏷️

  • Description: Recognize and extract license plate(s) from a vehicle image URL

  • Parameters:

    • imageUrl (string, required): Direct URL to an image of a vehicle's license plate
  • Example Prompts:

    What's the plate number in this image? https://api.carsxe.com/img/apis/plate_recognition.JPG

    Read the license plate from this photo: [image URL]

  • Output: Markdown with detected plates, confidence scores, bounding boxes, vehicle type, etc.


9. extract_vin_from_image 🔍

  • Description: Extract the VIN from a vehicle image using OCR

  • Parameters:

    • imageUrl (string, required): Direct URL to an image of a vehicle's VIN
  • Example Prompts:

    Extract the VIN from this image: https://user-images.githubusercontent.com/5663423/30922082-64edb4fa-a3a8-11e7-873e-3fbcdce8ea3a.png

    What's the VIN in this photo? https://res.cloudinary.com/carsxe/image/upload/q_auto/f_auto/v1713204144/base/images/vin-ocr/vin.jpg

  • Output: Markdown with detected VIN, confidence, bounding box, and candidates


10. get_year_make_model 📅

  • Description: Get comprehensive vehicle info by year, make, model, and optional trim

  • Parameters:

    • year (string, required)
    • make (string, required)
    • model (string, required)
    • trim (string, optional)
  • Example Prompts:

    What are the specs for a 2020 Toyota Camry?

    Tell me about the 2019 Honda Civic Sport trim

    What colors were available on the 2021 Ford F-150?

  • Output: Markdown with vehicle details, colors, features, options, and packages


11. decode_obd_code 🛠️

  • Description: Decode an OBD code and get diagnosis information

  • Parameters:

    • code (string, required): OBD code (e.g., P0115)
  • Example Prompts:

    My check engine light is on with code P0115 — what does it mean?

    Decode OBD code P0300

    I have a C1234 code on my dashboard — is it serious?

  • Output: Markdown with code, diagnosis, and date


12. check_lien_and_theft 🔒

  • Description: Get lien and theft information for a vehicle by VIN

  • Parameters:

    • vin (string, required): 17-character Vehicle Identification Number
  • Example Prompts:

    Is there a lien on WBAFR7C57CC811956?

    I'm buying a used car with VIN WBAFR7C57CC811956 — check if it's stolen

    Verify the title is clean for WBAFR7C57CC811956

  • Output: Markdown with lien holder information, theft records, recovery dates, and status


🔗 Chaining Tools — Power User Examples

The real power of CarsXE MCP comes from chaining tools in a single conversation:

Scenario 1 — Pre-purchase due diligence:

  1. Decode plate 7XER187 in California

  2. Now get its full history

  3. Does it have any open recalls?

  4. What's it worth if I buy it today?

Scenario 2 — Spotted a car on the street:

  1. Read the plate from this image: [photo URL]

  2. Look up that plate in Texas

  3. Show me photos of that car model

Scenario 3 — Mechanic / service shop:

  1. Decode this VIN from the dashboard photo: [image URL]

  2. Get its full specs

  3. My customer says the check engine code is P0300 — what does that mean for this vehicle?


🔐 OAuth 2.1 (Claude.ai custom connector)

The hosted server at https://mcp.carsxe.com/mcp supports two authentication methods:

  1. API key (unchanged) — X-API-Key header, Authorization: Bearer <api-key>, or ?key= query parameter. Used by Claude Desktop / mcp-remote and local clients.
  2. OAuth 2.1 — used by hosted MCP clients such as the Claude.ai custom connector. Clicking Connect in Claude.ai runs a standard Authorization Code + PKCE flow: dynamic client registration (RFC 7591), browser sign-in on the CarsXE consent page, then token exchange. Access tokens (mcp_at_*, 1 h) map to the user's CarsXE API key; refresh tokens (mcp_rt_*, 90 d) are rotated on every refresh.

Requests with no credentials get 401 with a WWW-Authenticate challenge, which is what prompts Claude.ai to start the flow.

Environment variables

VariableDefaultPurpose
OAUTH_ISSUERhttps://mcp.carsxe.comIssuer / endpoint base in the discovery metadata
OAUTH_WEB_BASEhttps://api.carsxe.comCarsXE web app hosting the OAuth logic
MCP_OAUTH_INTERNAL_SECRET(unset)Set in the host environment, never commit. When unset, OAuth bearer tokens are rejected but API-key auth keeps working.

The Cloudflare Workers deployment (src/index.ts) does not serve the OAuth surface — only the GCP Cloud Run deployment (src/index.gcp.ts) behind mcp.carsxe.com does.

常见问题

io.github.carsxe/carsxe-mcp 是什么?

用于 CarsXE 车辆数据的 MCP 服务器,可查询 VIN、参数规格、历史记录、图片、recall 与 OBD code。

相关 Skills

网页构建器

by anthropics

Universal
热门

面向复杂 claude.ai HTML artifact 开发,快速初始化 React + Tailwind CSS + shadcn/ui 项目并打包为单文件 HTML,适合需要状态管理、路由或多组件交互的页面。

在 claude.ai 里做复杂网页 Artifact 很省心,多组件、状态和路由都能顺手搭起来,React、Tailwind 与 shadcn/ui 组合效率高、成品也更精致。

编码与调试
未扫描172.7k

网页应用测试

by anthropics

Universal
热门

用 Playwright 为本地 Web 应用编写自动化测试,支持启动开发服务器、校验前端交互、排查 UI 异常、抓取截图与浏览器日志,适合调试动态页面和回归验证。

借助 Playwright 一站式验证本地 Web 应用前端功能,调 UI 时还能同步查看日志和截图,定位问题更快。

编码与调试
未扫描172.7k

前端设计

by anthropics

Universal
热门

面向组件、页面、海报和 Web 应用开发,按鲜明视觉方向生成可直接落地的前端代码与高质感 UI,适合做 landing page、Dashboard 或美化现有界面,避开千篇一律的 AI 审美。

想把页面做得既能上线又有设计感,就用前端设计:组件到整站都能产出,难得的是能避开千篇一律的 AI 味。

编码与调试
未扫描172.7k

相关 MCP Server

GitHub

编辑精选

by GitHub

热门

GitHub 是 MCP 官方参考服务器,让 Claude 直接读写你的代码仓库和 Issues。

这个参考服务器解决了开发者想让 AI 安全访问 GitHub 数据的问题,适合需要自动化代码审查或 Issue 管理的团队。但注意它只是参考实现,生产环境得自己加固安全。

编码与调试
89.7k

by Context7

热门

Context7 是实时拉取最新文档和代码示例的智能助手,让你告别过时资料。

它能解决开发者查找文档时信息滞后的问题,特别适合快速上手新库或跟进更新。不过,依赖外部源可能导致偶尔的数据延迟,建议结合官方文档使用。

编码与调试
60.2k

by tldraw

热门

tldraw 是让 AI 助手直接在无限画布上绘图和协作的 MCP 服务器。

这解决了 AI 只能输出文本、无法视觉化协作的痛点——想象让 Claude 帮你画流程图或白板讨论。最适合需要快速原型设计或头脑风暴的开发者。不过,目前它只是个基础连接器,你得自己搭建画布应用才能发挥全部潜力。

编码与调试
49.9k

评论