Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (49 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 1.53 KB

Contributing to openapi-mcp-ts

Hey! Thanks for thinking about contributing. We appreciate it.

Quick Start

# Clone the repo
git clone https://github.com/procoders/openapi-mcp-ts.git
cd openapi-mcp-ts

# Install deps
npm install

# Run in dev mode
npm run dev -- --spec-url https://petstore.swagger.io/v3/openapi.json --upstream-url https://petstore.swagger.io/v3

What We're Looking For

  • Bug fixes (always welcome)
  • New OpenAPI features support
  • Better error messages
  • Performance improvements
  • Docs improvements

Before You Start

For bigger changes, open an issue first so we can chat about the approach. Nothing worse than spending hours on something and finding out we're going in a different direction.

Making Changes

  1. Fork the repo
  2. Create a branch (git checkout -b fix/something-broken)
  3. Make your changes
  4. Run the checks: 
    npm run typecheck
npm run lint
npm run build
  5. Commit with a clear message
  6. Push and open a PR

Code Style

  • TypeScript with strict mode
  • ESLint handles the rest
  • Keep functions small and focused
  • Comments for the "why", not the "what"

Testing Your Changes

# Start the server
npm run dev -- --spec-url <your-test-spec> --upstream-url <upstream>

# In another terminal, test with curl
curl -s http://localhost:8080/health
curl -s http://localhost:8080/tools | jq

For MCP testing, use Claude Desktop or any MCP client.

Questions?

Open an issue or hit us up at mcpize.com.

Thanks for helping make this better.