CONTRIBUTING.md

Contributing to AlphaVantage MCP Server

Thanks for your interest in contributing! 🎉
This project is the official MCP (Model Context Protocol) server for Alpha Vantage. Here's how to get started with local development and testing.

---

🚀 Getting Started

1. Clone the repo

git clone https://github.com/calvernaz/alphavantage.git
cd alphavantage

Set up your environment

You'll need an Alpha Vantage API key.

Create a .env file in the project root:

touch .env

Add your API key to the .env file:

ALPHAVANTAGE_API_KEY=your_api_key_here

Alternatively, you can export it directly in your terminal:

export ALPHAVANTAGE_API_KEY=your_api_key_here

🧪 Running Locally with Inspector

Use the MCP Inspector to run and test your server locally with hot reload.

npm install -g @modelcontextprotocol/inspector

Then, run the server:

npx @modelcontextprotocol/inspector uv --directory ~/alphavantage run alphavantage

Replace ~/code/alphavantage with your actual path to this repo.