Skip to content

Improve README tools section #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Improve README tools section #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
327 changes: 148 additions & 179 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,185 +65,154 @@ Install the server, for example, on [Claude Desktop](https://claude.ai/download)

## Available Tools

### `RRPONTSYD`

* **Description**: Retrieve data for *Overnight Reverse Repurchase Agreements* (`RRPONTSYD`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `CPIAUCSL`

* **Description**: Retrieve data for *Consumer Price Index for All Urban Consumers* (`CPIAUCSL`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `MORTGAGE30US`

* **Description**: Retrieve data for *30-Year Fixed Rate Mortgage Average in the United States* (`MORTGAGE30US`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `T10Y2Y`

* **Description**: Retrieve data for *10-Year Treasury Constant Maturity Minus 2-Year Treasury Constant Maturity* (`T10Y2Y`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `UNRATE`

* **Description**: Retrieve data for *Unemployment Rate* (`UNRATE`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `WALCL`

* **Description**: Retrieve data for *Federal Reserve Total Assets* (`WALCL`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `GDP`

* **Description**: Retrieve data for *Gross Domestic Product* (`GDP`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `GDPC1`

* **Description**: Retrieve data for *Real Gross Domestic Product* (`GDPC1`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `DGS10`

* **Description**: Retrieve data for *10-Year Treasury Constant Maturity Rate* (`DGS10`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `CSUSHPINSA`

* **Description**: Retrieve data for *S&P/Case-Shiller U.S. National Home Price Index* (`CSUSHPINSA`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `BAMLH0A0HYM2`

* **Description**: Retrieve data for *ICE BofA US High Yield Index Option-Adjusted Spread* (`BAMLH0A0HYM2`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `T10YIE`

* **Description**: Retrieve data for *10-Year Breakeven Inflation Rate* (`T10YIE`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `FPCPITOTLZGUSA`

* **Description**: Retrieve data for *Inflation, consumer prices for the United States* (`FPCPITOTLZGUSA`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `MSPUS`

* **Description**: Retrieve data for *Median Sales Price of Houses Sold for the United States* (`MSPUS`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `M1SL`

* **Description**: Retrieve data for *M1 Money Stock* (`M1SL`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `DRCCLACBS`

* **Description**: Retrieve data for *Delinquency Rate on Credit Card Loans, All Commercial Banks* (`DRCCLACBS`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `DFII10`

* **Description**: Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Daily)* (`DFII10`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `FII10`

* **Description**: Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Monthly)* (`FII10`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `WFII10`

* **Description**: Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Weekly)* (`WFII10`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.

### `RIFLGFCY10XIINA`

* **Description**: Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Annual)* (`RIFLGFCY10XIINA`) from FRED®.
* **Parameters**:
* `start_date` _(string, optional)_: Start date in `YYYY-MM-DD` format.
* `end_date` _(string, optional)_: End date in `YYYY-MM-DD` format.
* `limit` _(number, optional)_: Maximum number of observations to return.
* `sort_order` _(enum["asc", "desc"], optional)_: Sort order of observations.
All tools support the same optional parameters:

* `start_date` (`YYYY-MM-DD`)
* `end_date` (`YYYY-MM-DD`)
* `limit` – maximum number of observations
* `sort_order` – either `asc` or `desc`

Use the toggles below to view a description of each tool.

<details>
<summary>`RRPONTSYD` – Overnight Reverse Repurchase Agreements</summary>

Retrieve data for *Overnight Reverse Repurchase Agreements* (`RRPONTSYD`)

</details>

<details>
<summary>`CPIAUCSL` – Consumer Price Index for All Urban Consumers</summary>

Retrieve data for *Consumer Price Index for All Urban Consumers* (`CPIAUCSL`)

</details>

<details>
<summary>`MORTGAGE30US` – 30-Year Fixed Rate Mortgage Average in the United States</summary>

Retrieve data for *30-Year Fixed Rate Mortgage Average in the United States* (`MORTGAGE30US`)

</details>

<details>
<summary>`T10Y2Y` – 10-Year Treasury Constant Maturity Minus 2-Year Treasury Constant Maturity</summary>

Retrieve data for *10-Year Treasury Constant Maturity Minus 2-Year Treasury Constant Maturity* (`T10Y2Y`)

</details>

<details>
<summary>`UNRATE` – Unemployment Rate</summary>

Retrieve data for *Unemployment Rate* (`UNRATE`)

</details>

<details>
<summary>`WALCL` – Federal Reserve Total Assets</summary>

Retrieve data for *Federal Reserve Total Assets* (`WALCL`)

</details>

<details>
<summary>`GDP` – Gross Domestic Product</summary>

Retrieve data for *Gross Domestic Product* (`GDP`)

</details>

<details>
<summary>`GDPC1` – Real Gross Domestic Product</summary>

Retrieve data for *Real Gross Domestic Product* (`GDPC1`)

</details>

<details>
<summary>`DGS10` – 10-Year Treasury Constant Maturity Rate</summary>

Retrieve data for *10-Year Treasury Constant Maturity Rate* (`DGS10`)

</details>

<details>
<summary>`CSUSHPINSA` – S&P/Case-Shiller U.S. National Home Price Index</summary>

Retrieve data for *S&P/Case-Shiller U.S. National Home Price Index* (`CSUSHPINSA`)

</details>

<details>
<summary>`BAMLH0A0HYM2` – ICE BofA US High Yield Index Option-Adjusted Spread</summary>

Retrieve data for *ICE BofA US High Yield Index Option-Adjusted Spread* (`BAMLH0A0HYM2`)

</details>

<details>
<summary>`T10YIE` – 10-Year Breakeven Inflation Rate</summary>

Retrieve data for *10-Year Breakeven Inflation Rate* (`T10YIE`)

</details>

<details>
<summary>`FPCPITOTLZGUSA` – Inflation, consumer prices for the United States</summary>

Retrieve data for *Inflation, consumer prices for the United States* (`FPCPITOTLZGUSA`)

</details>

<details>
<summary>`MSPUS` – Median Sales Price of Houses Sold for the United States</summary>

Retrieve data for *Median Sales Price of Houses Sold for the United States* (`MSPUS`)

</details>

<details>
<summary>`M1SL` – M1 Money Stock</summary>

Retrieve data for *M1 Money Stock* (`M1SL`)

</details>

<details>
<summary>`DRCCLACBS` – Delinquency Rate on Credit Card Loans, All Commercial Banks</summary>

Retrieve data for *Delinquency Rate on Credit Card Loans, All Commercial Banks* (`DRCCLACBS`)

</details>

<details>
<summary>`DFII10` – Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Daily)</summary>

Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Daily)* (`DFII10`)

</details>

<details>
<summary>`FII10` – Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Monthly)</summary>

Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Monthly)* (`FII10`)

</details>

<details>
<summary>`WFII10` – Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Weekly)</summary>

Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Weekly)* (`WFII10`)

</details>

<details>
<summary>`RIFLGFCY10XIINA` – Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Annual)</summary>

Retrieve data for *Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Inflation-Indexed (Annual)* (`RIFLGFCY10XIINA`)

</details>

## Testing

Expand Down
Loading