diff --git a/README.md b/README.md index 77985d4..58bc490 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Federal Reserve Economic Data MCP Server +[![smithery badge](https://smithery.ai/badge/@stefanoamorelli/fred-mcp-server)](https://smithery.ai/server/@stefanoamorelli/fred-mcp-server) + > [!IMPORTANT] > *Disclaimer*: This open-source project is not affiliated with, sponsored by, or endorsed by the *Federal Reserve* or the *Federal Reserve Bank of St. Louis*. "FRED" is a registered trademark of the *Federal Reserve Bank of St. Louis*, used here for descriptive purposes only. @@ -27,6 +29,16 @@ A Model Context Protocol (`MCP`) server for accessing Federal Reserve Economic D ## Installation +### Installing via Smithery + +To install Federal Reserve Economic Data Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@stefanoamorelli/fred-mcp-server): + +```bash +npx -y @smithery/cli install @stefanoamorelli/fred-mcp-server --client claude +``` + +### Manual Installation + 1. Clone the repository: ```bash git clone https://github.com/stefanoamorelli/fred-mcp-server.git diff --git a/smithery.yaml b/smithery.yaml new file mode 100644 index 0000000..7adf422 --- /dev/null +++ b/smithery.yaml @@ -0,0 +1,19 @@ +# Smithery configuration file: https://smithery.ai/docs/build/project-config + +startCommand: + type: stdio + configSchema: + # JSON Schema defining the configuration options for the MCP. + type: object + required: + - fredApiKey + properties: + fredApiKey: + type: string + description: FRED API key to authenticate with FREDĀ® API + commandFunction: + # A JS function that produces the CLI command based on the given config to start the MCP on stdio. + |- + (config) => ({command: 'node', args: ['build/index.js'], env: {FRED_API_KEY: config.fredApiKey}}) + exampleConfig: + fredApiKey: YOUR_FRED_API_KEY