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

Fork the Repository

Fork fred-mcp-server on GitHub

Clone Your Fork

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

Install Dependencies

pnpm install

Build the Project

pnpm run build

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

Create Branch

git checkout -b feature/your-feature-name

Make Changes

Write code, add tests, update docs

Run Tests

Ensure all tests pass

Commit

git commit -m "feat: your feature description"

Push

git push origin feature/your-feature-name

Open PR

Create pull request on GitHub

Code of Conduct

Please read and follow our Code of Conduct.

Questions?

GitHub Discussions
Open an issue
Email: [email protected]

Next Steps

Code of Conduct

Community guidelines

Security

Report security issues

​Contributing

​Ways to Contribute

Report Bugs

Suggest Features

Improve Docs

Submit Code

​Development Setup

​Making Changes

​Code Style

​Testing

​Commits

​Pull Requests

​Code of Conduct

​Questions?

​Next Steps

Code of Conduct

Security

Contributing

Ways to Contribute

Development Setup

Making Changes

Code Style

Testing

Commits

Pull Requests

Code of Conduct

Questions?

Next Steps