Skip to content

llms-install.md

Latest commit

 

History

History
138 lines (101 loc) · 3.13 KB

llms-install.md

File metadata and controls

138 lines (101 loc) · 3.13 KB
Raw

FXMacroData MCP - Universal Install Guide

This guide is written for AI agents and humans installing FXMacroData MCP across multiple clients, not only one marketplace or editor.

1. What this repo is

  • Package: mcp-server-fxmacrodata
  • Purpose: a local MCP server for the FXMacroData API
  • Transport: stdio MCP
  • Primary install path: uvx mcp-server-fxmacrodata

USD data works without an API key. Non-USD data requires FXMACRODATA_API_KEY.

2. Quick start

Use the no-install path first:

uvx mcp-server-fxmacrodata

For full access:

FXMACRODATA_API_KEY=your_key uvx mcp-server-fxmacrodata

If your environment prefers pip:

pip install mcp-server-fxmacrodata
mcp-server-fxmacrodata

3. Client configuration

Use the snippet format your client expects.

Claude Desktop / Cursor / OpenClaw-style mcpServers

{
  "mcpServers": {
    "fxmacrodata": {
      "command": "uvx",
      "args": ["mcp-server-fxmacrodata"],
      "env": {
        "FXMACRODATA_API_KEY": "your_key"
      }
    }
  }
}

VS Code / GitHub Copilot-style servers

{
  "servers": {
    "fxmacrodata": {
      "command": "uvx",
      "args": ["mcp-server-fxmacrodata"],
      "env": {
        "FXMACRODATA_API_KEY": "your_key"
      }
    }
  }
}

4. Recommended verification flow

  1. Start the server.
  2. Confirm the client connects.
  3. Call tools/list.
  4. Run a public tool first, such as ping or data_catalogue with USD.
  5. Run a non-USD call only after setting FXMACRODATA_API_KEY.

Suggested smoke tests:

uvx mcp-server-fxmacrodata

Then ask the client:

  1. "List the available USD indicators."
  2. "Show upcoming USD GDP releases."
  3. "Get EUR inflation data for the last 12 months."

5. Supported tools

  • ping
  • data_catalogue
  • release_calendar
  • forex
  • indicator_query
  • market_sessions
  • cot_data
  • commodities

6. API key guidance

  • Store the API key in the client environment, not in source control.
  • Use the key only for protected or non-USD requests.
  • USD paths should work without a key.

7. Troubleshooting

  1. The client says no tools are available:
  • Re-check that the command is uvx mcp-server-fxmacrodata.
  • Restart the client after changing the config.
  1. Non-USD requests fail:
  • Confirm FXMACRODATA_API_KEY is set.
  • Try a fresh terminal session so the environment variable is loaded.
  1. Python package install fails:
  • Prefer uvx first.
  • If using pip, ensure your Python environment is up to date.
  1. The client expects a remote MCP server:
  • This repo is the local stdio server package.
  • If you need the hosted remote endpoint, use the FXMacroData MCP service at https://fxmacrodata.com/mcp.

8. Policy and support links

9. Copy for installers

If an autonomous installer agent needs a one-line summary, use this:

Install FXMacroData MCP with uvx mcp-server-fxmacrodata, then set FXMACRODATA_API_KEY for non-USD access.