github-to-mcp-monorepo 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,167 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+#### Web Application Enhancements
+- **Interactive Playground**: Test MCP tools in real-time with dynamic form generation
+  - Resizable split-panel interface with drag-to-resize functionality
+  - Tool search and filtering with category chips
+  - Dynamic parameter forms based on JSON schemas
+  - Mock execution with formatted JSON responses
+  - Demo mode with sample tools for first-time users
+- **Generation Progress Indicator**: Multi-step visual progress tracking
+  - Circular progress ring with percentage display
+  - 4 weighted steps (Fetching, Classifying, Extracting, Generating)
+  - Real-time tools found counter
+  - Error state handling per step
+- **Branch/Tag/Commit Selection**: Choose specific Git references for conversion
+  - GitHub API integration for fetching branches and tags
+  - Commit SHA support
+  - Default branch detection
+  - Search/filter within refs
+- **Claude Config Export**: One-click configuration setup
+  - NPX method (zero-install)
+  - Local method (clone and build)
+  - Python method (Python-based server)
+  - Copy to clipboard with visual feedback
+  - Download as JSON file
+- **Advanced Tool Filtering**: Enhanced tool discovery and exploration
+  - Real-time search across names and descriptions
+  - Category filters (OpenAPI, GraphQL, README)
+  - Sort options (Alphabetical, Source Type, Confidence)
+  - Results counter
+- **Enhanced Tool Display**: Improved tool list UI
+  - Collapsible tool cards with schema display
+  - Source type badges with color coding
+  - Expand/collapse all functionality
+  - Grouped view when sorting by source
+- **SplitView Component**: Reusable resizable panel layout
+  - Mouse drag interaction for resizing
+  - Maximize/minimize buttons for each panel
+  - Configurable minimum widths
+  - Smooth transitions and hover effects
+
+#### Developer Experience
+- Comprehensive component documentation
+- TypeScript interfaces for all props
+- Custom hooks for state management
+- Memoization for performance optimization
+
+### Added (Continued)
+- Additional extraction patterns for Rust MCP servers
+- Support for extracting tools from TypeDoc comments
+
+### Changed
+- Improved error messages for rate limiting
+- Refactored ConversionResult to use new ToolList and ClaudeConfigExport components
+- Enhanced GithubUrlInput with optional branch selector integration
+
+### Fixed
+- Edge case in Python decorator parsing with multiline strings
+- TypeScript type safety in LoadingSteps component
+
+---
+
+## [1.0.0] - 2026-01-11
+
+### Added
+
+#### Core Features
+- **Universal Conversion Engine**: Convert any GitHub repository into an MCP server
+- **Smart Detection**: Automatic extraction from OpenAPI specs, README patterns, and code
+- **Repository Classification**: Auto-identify repo type (api-sdk, mcp-server, cli-tool, library, documentation)
+- **Universal Tools**: Every repo gets 4 base tools (get_readme, list_files, read_file, search_code)
+
+#### Extraction Sources
+- OpenAPI/Swagger specification parsing
+- README.md tool list extraction
+- Python `@mcp.tool` decorator detection
+- TypeScript/JavaScript `server.tool()` pattern detection
+- Package.json metadata extraction
+
+#### Web Application
+- Modern Next.js 14 web interface
+- Dark/Light theme support with persistence
+- Conversion history with localStorage
+- Real-time tool preview
+- One-click config generation for Claude, Cursor, ChatGPT
+- Download MCP server code
+
+#### CLI
+- `npx @nirholas/github-to-mcp <url>` command
+- JSON output support
+- Configurable output directory
+- Verbose logging option
+
+#### Developer Experience
+- Full TypeScript support with strict mode
+- Comprehensive type definitions
+- Programmatic API for integration
+- Monorepo structure with pnpm workspaces
+
+### Technical Details
+
+#### Packages
+- `@nirholas/github-to-mcp` - Core conversion engine
+- `@github-to-mcp/openapi-parser` - OpenAPI specification parser
+- `@github-to-mcp/web` - Next.js web application
+
+#### Dependencies
+- Next.js 14.2
+- React 18.3
+- TypeScript 5.5
+- Tailwind CSS 3.4
+- Radix UI primitives
+
+#### Browser Support
+- Chrome 90+
+- Firefox 88+
+- Safari 14+
+- Edge 90+
+
+### Security
+- Input validation for all GitHub URLs
+- Rate limiting on API endpoints
+- Security headers (CSP, HSTS, X-Frame-Options)
+- No persistent data storage
+
+### Known Issues
+- Large repositories (>1000 files) may timeout on free tier
+- Private repositories require GitHub token
+- Some edge cases in Python multiline string parsing
+
+---
+
+## Version History Summary
+
+| Version | Date | Highlights |
+|---------|------|------------|
+| 1.0.0 | 2026-01-11 | Initial release |
+
+---
+
+## Migration Guides
+
+### Upgrading to 1.x
+
+This is the initial release. No migration needed.
+
+---
+
+## Release Schedule
+
+- **Patch releases** (1.0.x): As needed for bug fixes
+- **Minor releases** (1.x.0): Monthly with new features
+- **Major releases** (x.0.0): When breaking changes are necessary
+
+---
+
+[Unreleased]: https://github.com/nirholas/github-to-mcp/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/nirholas/github-to-mcp/releases/tag/v1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,327 @@
+# Contributing to GitHub to MCP
+
+Thank you for your interest in contributing to GitHub to MCP! This document provides guidelines and instructions for contributing.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Pull Request Process](#pull-request-process)
+- [Code Style Guide](#code-style-guide)
+- [Testing Requirements](#testing-requirements)
+- [Issue Guidelines](#issue-guidelines)
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [security@example.com].
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 22.x or later (see `.nvmrc`)
+- pnpm 10.x or later
+- Git 2.x or later
+
+### Fork and Clone
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/github-to-mcp.git
+   cd github-to-mcp
+   ```
+3. Add the upstream remote:
+   ```bash
+   git remote add upstream https://github.com/nirholas/github-to-mcp.git
+   ```
+
+## Development Setup
+
+### Install Dependencies
+
+```bash
+pnpm install
+```
+
+### Build Packages
+
+```bash
+pnpm build
+```
+
+### Run Development Server
+
+```bash
+pnpm dev
+```
+
+### Project Structure
+
+```
+github-to-mcp/
+├── apps/
+│   └── web/                 # Next.js web application
+│       ├── app/             # App router pages
+│       ├── components/      # React components
+│       ├── hooks/           # Custom hooks
+│       ├── lib/             # Utilities
+│       └── types/           # TypeScript types
+├── packages/
+│   ├── core/                # Main conversion engine
+│   │   └── src/
+│   │       ├── index.ts     # Main exports
+│   │       ├── cli.ts       # CLI entry point
+│   │       ├── github-client.ts
+│   │       ├── readme-extractor.ts
+│   │       ├── code-extractor.ts
+│   │       └── types.ts
+│   └── openapi-parser/      # OpenAPI spec parser
+│       └── src/
+│           ├── parser.ts
+│           ├── analyzer.ts
+│           ├── transformer.ts
+│           └── generator.ts
+└── docs/                    # Documentation
+```
+
+## Making Changes
+
+### Branch Naming
+
+Use descriptive branch names:
+- `feat/add-python-support` - New features
+- `fix/handle-rate-limit` - Bug fixes
+- `docs/update-api-reference` - Documentation
+- `refactor/extract-utils` - Code refactoring
+- `test/add-integration-tests` - Test additions
+
+### Commit Messages
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<type>(<scope>): <subject>
+
+[optional body]
+
+[optional footer]
+```
+
+Types:
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation only
+- `style`: Formatting, no code change
+- `refactor`: Code restructuring
+- `test`: Adding tests
+- `chore`: Maintenance tasks
+
+Examples:
+```
+feat(core): add Python MCP decorator extraction
+fix(web): handle rate limit errors gracefully
+docs(api): update generateFromGithub examples
+```
+
+## Pull Request Process
+
+### Before Submitting
+
+1. **Sync with upstream**:
+   ```bash
+   git fetch upstream
+   git rebase upstream/main
+   ```
+
+2. **Run all checks**:
+   ```bash
+   pnpm build
+   pnpm test
+   pnpm lint
+   pnpm typecheck
+   ```
+
+3. **Update documentation** if needed
+
+4. **Add a changeset** (for user-facing changes):
+   ```bash
+   pnpm changeset
+   ```
+   This will prompt you to describe your change and select the semver bump type.
+
+### PR Requirements
+
+- [ ] All tests pass
+- [ ] No TypeScript errors
+- [ ] Linting passes
+- [ ] Documentation updated (if applicable)
+- [ ] Changeset added (for user-facing changes)
+- [ ] PR description explains the change
+
+### Pre-commit Hooks
+
+This project uses Husky to run pre-commit checks automatically. When you commit:
+- TypeScript/TSX files are linted with ESLint
+- JSON, Markdown, and YAML files are formatted with Prettier
+
+If a check fails, fix the issues before committing.
+
+### Review Process
+
+1. A maintainer will review your PR within 3 business days
+2. Address any requested changes
+3. Once approved, a maintainer will merge
+
+## Code Style Guide
+
+### TypeScript
+
+- Use TypeScript strict mode
+- Prefer `const` over `let`
+- Use explicit return types for public functions
+- Use interface over type for object shapes
+- No `any` types (use `unknown` if necessary)
+
+```typescript
+// Good
+export function parseReadme(content: string): ParseResult {
+  // ...
+}
+
+// Bad
+export function parseReadme(content) {
+  // ...
+}
+```
+
+### React Components
+
+- Use functional components with hooks
+- Props interface should be named `{ComponentName}Props`
+- Use semantic HTML elements
+- Include accessibility attributes
+
+```typescript
+interface ButtonProps {
+  variant?: 'primary' | 'secondary';
+  onClick: () => void;
+  children: React.ReactNode;
+}
+
+export function Button({ variant = 'primary', onClick, children }: ButtonProps) {
+  return (
+    <button
+      className={cn(buttonVariants({ variant }))}
+      onClick={onClick}
+      type="button"
+    >
+      {children}
+    </button>
+  );
+}
+```
+
+### File Organization
+
+- One component per file
+- Co-locate tests with source files
+- Export from index files
+- Keep files under 300 lines
+
+### Naming Conventions
+
+| Type | Convention | Example |
+|------|------------|---------|
+| Files | kebab-case | `github-client.ts` |
+| Components | PascalCase | `CodeBlock.tsx` |
+| Functions | camelCase | `parseReadme()` |
+| Constants | UPPER_SNAKE | `MAX_RETRIES` |
+| Types/Interfaces | PascalCase | `ConversionResult` |
+
+## Testing Requirements
+
+### Test Structure
+
+```
+src/
+├── module.ts
+└── module.test.ts
+```
+
+### Running Tests
+
+```bash
+# All tests
+pnpm test
+
+# Watch mode
+pnpm test:watch
+
+# Coverage
+pnpm test:coverage
+```
+
+### Test Guidelines
+
+1. **Unit tests** for pure functions
+2. **Integration tests** for API routes
+3. **E2E tests** for critical user flows
+
+```typescript
+import { describe, it, expect } from 'vitest';
+import { parseGitHubUrl } from './utils';
+
+describe('parseGitHubUrl', () => {
+  it('should parse valid GitHub URLs', () => {
+    const result = parseGitHubUrl('https://github.com/owner/repo');
+    expect(result).toEqual({ owner: 'owner', repo: 'repo' });
+  });
+
+  it('should return null for invalid URLs', () => {
+    const result = parseGitHubUrl('not-a-url');
+    expect(result).toBeNull();
+  });
+});
+```
+
+### Coverage Requirements
+
+- Minimum 80% line coverage
+- 100% coverage for critical paths (parsing, generation)
+
+## Issue Guidelines
+
+### Bug Reports
+
+Include:
+- Node.js version
+- pnpm version
+- Operating system
+- Steps to reproduce
+- Expected vs actual behavior
+- Error messages/logs
+
+### Feature Requests
+
+Include:
+- Use case description
+- Proposed solution
+- Alternatives considered
+- Willingness to implement
+
+### Questions
+
+For questions, use:
+- GitHub Discussions (preferred)
+- Stack Overflow with tag `github-to-mcp`
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+Thank you for contributing! 🎉

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.