Contributing

April 29, 2026 · View on GitHub

Prerequisites

  • Node.js >= 25.3.0
  • npm >= 11.11.0

Setup

git clone https://github.com/imbenrabi/Financial-Modeling-Prep-MCP-Server
cd Financial-Modeling-Prep-MCP-Server
npm install
npm run build

Development

CommandPurpose
npm run devWatch mode (tsx watch)
npm run buildCompile TypeScript to dist/
npm startRun the compiled server

Testing

CommandPurpose
npm run test:runRun unit tests (Vitest)
npm run typecheckTypeScript check without emit
npm run testVitest watch mode

Before Submitting

  1. npm run build
  2. npm run test:run
  3. npm run typecheck

Version Sync

Keep package.json, server.json, and other tracked files in sync:

  • npm run version:validate — check versions match
  • npm run version:sync — bump and sync versions

Project Structure

DirectoryContents
src/apiHTTP clients
src/toolsMCP tool registrations
src/toolception-adaptersFramework integration
src/server-mode-enforcerMode configuration
src/constantsTool sets and defaults
src/endpointsHTTP endpoints
src/promptsMCP prompts

License

Apache-2.0