Skip to main content

​
Contributing

We welcome contributions to the FRED MCP Server! This guide will help you get started.

​
Ways to Contribute

Report Bugs

Found an issue? Let us know on GitHub Issues

Suggest Features

Have an idea? Open a feature request

Improve Docs

Help make documentation clearer

Submit Code

Fix bugs or add features via pull requests

​
Development Setup

1

Fork the Repository

Fork fred-mcp-server on GitHub
2

Clone Your Fork

git clone https://github.com/YOUR_USERNAME/fred-mcp-server.git
cd fred-mcp-server
3

Install Dependencies

pnpm install
4

Build the Project

pnpm run build
5

Run Tests

pnpm test

​
Making Changes

​
Code Style

  • Follow existing code style
  • Use TypeScript for type safety
  • Add tests for new features
  • Update documentation

​
Testing

# Run all tests
pnpm test

# Run specific test
pnpm test -- registry.test.ts

# Watch mode
pnpm run test:watch

​
Commits

Use conventional commit messages: 
feat: add new search filter
fix: resolve rate limiting issue
docs: update installation guide
test: add tests for browse functionality

​
Pull Requests

1

Create Branch

git checkout -b feature/your-feature-name
2

Make Changes

Write code, add tests, update docs
3

Run Tests

Ensure all tests pass
4

Commit

git commit -m "feat: your feature description"
5

Push

git push origin feature/your-feature-name
6

Open PR

Create pull request on GitHub

​
Code of Conduct

Please read and follow our Code of Conduct.

​
Questions?

​
Next Steps

Code of Conduct

Community guidelines

Security

Report security issues