docs: add comprehensive project documentation and contribution guidelines

This commit introduces several key documentation updates:
- Create CONTRIBUTING.md with detailed contribution guidelines
- Update README.md with improved project overview and structure
- Add getting-started.md with step-by-step setup instructions
- Enhance package READMEs with consistent formatting and badges
- Provide clear usage examples and configuration details for MCP DevTools

Author: prokopsimek

CONTRIBUTING.md

@@ -0,0 +1,189 @@
+# Contributing to MCP DevTools
+
+Thank you for your interest in contributing to MCP DevTools! This document provides guidelines and instructions for contributing to this project.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Workflow](#development-workflow)
+- [Pull Request Process](#pull-request-process)
+- [Coding Standards](#coding-standards)
+- [Commit Guidelines](#commit-guidelines)
+- [Testing](#testing)
+- [Documentation](#documentation)
+- [Release Process](#release-process)
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our Code of Conduct:
+
+- Be respectful and inclusive
+- Use welcoming and inclusive language
+- Be collaborative and constructive
+- Focus on what is best for the community
+- Show empathy towards other community members
+
+## Getting Started
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) (v14 or later)
+- [pnpm](https://pnpm.io/) for package management
+
+### Setup
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+   ```bash
+   git clone https://github.com/YOUR-USERNAME/mcp-devtools.git
+   cd mcp-devtools
+   ```
+3. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+4. Build the packages:
+   ```bash
+   pnpm build
+   ```
+
+## Development Workflow
+
+1. Create a new branch for your feature or bugfix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+2. Make your changes, following the [coding standards](#coding-standards)
+
+3. For development with auto-rebuild:
+
+   ```bash
+   pnpm dev
+   ```
+
+4. Test your changes:
+
+   ```bash
+   pnpm test
+   ```
+
+5. Lint your code:
+
+   ```bash
+   pnpm lint
+   ```
+
+6. Commit your changes following the [commit guidelines](#commit-guidelines)
+
+## Pull Request Process
+
+1. Update the README.md and documentation with details of changes, if applicable
+2. Ensure all tests pass and code linting is clean
+3. Submit a pull request to the `main` branch of the original repository
+4. The maintainers will review your PR and provide feedback
+5. Once approved, your PR will be merged
+
+## Coding Standards
+
+- Follow the existing code style
+- Use TypeScript for all new code
+- Ensure code is properly typed
+- Follow the principle of [clean code](https://github.com/ryanmcdermott/clean-code-javascript)
+- Use meaningful variable and function names
+- Write comments for non-obvious code
+- Keep functions small and focused on a single responsibility
+
+### TypeScript Style Guide
+
+- Use interfaces for object types
+- Use proper access modifiers for class members
+- Avoid using `any` type where possible
+- Use arrow functions for callbacks
+- Use async/await instead of Promise chains when appropriate
+
+## Commit Guidelines
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/) to automate versioning and changelog generation. Please format your commit messages following this pattern:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types:
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation changes
+- `style`: Changes that don't affect the code's meaning (formatting, etc.)
+- `refactor`: Code changes that neither fix bugs nor add features
+- `perf`: Performance improvements
+- `test`: Adding or fixing tests
+- `chore`: Changes to the build process or auxiliary tools
+
+Examples:
+
+```
+feat(jira): add comment creation endpoint
+fix(http-client): resolve timeout issue
+docs: update README with new setup instructions
+```
+
+Breaking changes should be indicated by adding an exclamation mark after the type/scope and describing the breaking change in the body of the commit message:
+
+```
+feat!: redesign http-client API
+
+BREAKING CHANGE: The http-client API has been completely redesigned to improve usability.
+```
+
+## Testing
+
+- Write tests for all new features and bug fixes
+- Ensure all existing tests pass before submitting a PR
+- Follow the existing testing patterns in the codebase
+- Aim for high test coverage, especially for critical functionality
+
+To run tests:
+
+```bash
+# Run all tests
+pnpm test
+
+# Run specific tests
+pnpm test -- --grep="pattern"
+```
+
+## Documentation
+
+- Update documentation for any changed functionality
+- Document all public APIs
+- Ensure README.md is kept up-to-date
+- Add JSDoc comments to functions and classes
+- Include code examples where appropriate
+
+## Release Process
+
+This repository is set up with automated release management using release-please and GitHub Actions for publishing packages to npmjs.org.
+
+### Beta Status
+
+All published packages are currently in beta status (0.x.x versions) and use the `beta` npm tag. During this phase:
+
+- Breaking changes may occur in minor version updates
+- Install the packages using: `npm install @mcp-devtools/package-name@beta`
+- When the project reaches stability, we will release version 1.0.0
+
+## Need Help?
+
+If you need help with contributing, please:
+
+- Check the existing [issues](https://github.com/modelcontextprotocol/mcp-devtools/issues) on GitHub
+- Open a new issue if your question isn't already addressed
+- Reach out to the maintainers through the project's communication channels
+
+Thank you for contributing to MCP DevTools!

README.md

@@ -1,93 +1,95 @@
 # MCP DevTools
 
+![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
+[![Beta Status](https://img.shields.io/badge/status-beta-orange)](https://github.com/modelcontextprotocol/mcp-devtools)
+
 MCP (Model Context Protocol) DevTools is a collection of packages that enable AI assistants to interact with external tools and services through the Model Context Protocol.
 
-## Overview
+## ✨ Highlights
 
-This monorepo contains packages that implement the Model Context Protocol, providing tools that enable AI assistants to access and manipulate data from external services. While initially offering Jira integration, this repository is designed as a general-purpose collection of MCP tools that will expand over time to support various services and use cases.
+- 🔌 **Seamless Integration**: Connect AI assistants to external services and tools
+- 🛠 **Extensible Framework**: Easily create new integrations with the Model Context Protocol
+- 🔍 **Powerful Interactions**: Enable AI to access and manipulate data from external services
+- 📊 **Jira Integration**: Robust Jira integration with comprehensive functionality
+- 🚀 **Developer-Friendly**: Simple setup with detailed documentation for the best developer experience
 
 > **Note**: This project is currently in beta (0.x.x versions). APIs may change between minor versions during the beta phase.
 
-## Packages
-
-### Core Packages (Internal Use Only)
-
-- **[@mcp-core/typescript-config](./core/typescript-config/README.md)** - Shared TypeScript configuration
-- **[@mcp-core/http-client](./core/http-client/README.md)** - HTTP client for API requests
-
-These core packages are for internal use only and are not published to npm.
+## 📦 Available Packages
 
-### MCP Servers (Published Packages)
+| Package                                         | Description                 | Status                                                                                                                  |
+| ----------------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| [@mcp-devtools/jira](./packages/jira/README.md) | Jira MCP server integration | [![npm version](https://img.shields.io/npm/v/@mcp-devtools/jira.svg)](https://www.npmjs.com/package/@mcp-devtools/jira) |
 
-- **[@mcp-devtools/jira](./packages/jira/README.md)** - Jira MCP server integration
+## 🚀 Quick Start
 
-Only the MCP server packages under the `@mcp-devtools` scope are published to npm.
+To use MCP DevTools with Cursor IDE:
 
-## Using MCP Tools
-
-MCP tools in this repository can be integrated with AI assistants that support the Model Context Protocol. Here's how to use them in different environments:
-
-To use MCP tools with Cursor IDE:
+```bash
+# Configure in Cursor settings (recommended)
+# Settings > Cursor Settings > MCP
+# Add a new MCP server with:
+# Name: Jira
+# Type: command
+# Command: env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx -y @mcp-devtools/jira
+```
 
-1. Configure the MCP server in Cursor settings
-2. Access the tool functionality directly through the Cursor IDE chat
+Once configured, interact with Jira through chat commands:
 
-### Jira Configuration
+```
+get task SCRUM-1
+```
 
-#### 1. General configuration via Cursor Settings (RECOMMENDED)
+## 📖 Documentation
 
-To use the Jira MCP server with Cursor IDE, configure the server in your Cursor settings:
+- [Jira Package Documentation](./packages/jira/README.md)
+- [Getting Started Guide](./docs/getting-started.md)
+- [Contributing Guidelines](./CONTRIBUTING.md)
 
-1. Open Cursor IDE
-2. Navigate to Settings (or CTRL+SHIFT+P) > Cursor Settings > MCP
-3. Add a new MCP server with the following configuration:
+## 🧩 Repository Structure
 
-- Server name: `Jira`
-- Type: `command`
-- Command: `env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx -y @mcp-devtools/jira`
+```
+mcp-devtools/
+├── core/                 # Infrastructure and utility packages
+│   ├── typescript-config/  # Shared TypeScript configuration
+│   └── http-client/        # HTTP client utilities
+│
+├── packages/             # Functional MCP server packages
+│   └── jira/               # Jira integration MCP server
+│       └── README.md         # Package documentation
+│
+└── ...
+```
 
-#### 2. Project-wide configuration via .cursor/mcp.json (NOT RECOMMENDED)
+## 🛠 Development
 
-> [!WARNING]  
-> This approach is not recommended as it might leak your secrets to other users when committing to the git repository.
+```bash
+# Install dependencies
+pnpm install
 
-For project-specific Jira configuration, you can create a `.cursor/mcp.json` file in your project root.
-This allows you to maintain separate MCP server configurations for different projects:
+# Build all packages
+pnpm build
 
-```json
-{
-  "mcpServers": {
-    "@mcp-devtools/jira": {
-      "command": "env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx",
-      "args": ["-y", "@mcp-devtools/jira"]
-    }
-  }
-}
+# Development with auto-rebuild
+pnpm dev
 ```
 
-### Using Jira MCP in Chat
+## 🤝 Contributing
 
-Once configured, you can interact with Jira through chat commands:
+Contributions are welcome! Please check our [Contributing Guidelines](./CONTRIBUTING.md) for details.
 
-```bash
-get task [ticket id]
-# example
-get task SCRUM-1
-```
+## 📄 License
 
-Available commands:
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-- `get task [ticket id]` - Retrieve details of a specific Jira ticket
-- `search tasks [query]` - Search for Jira tickets matching a query
-- `update task [ticket id] [field] [value]` - Update a field on a ticket
-- `get my tasks` - List tickets assigned to you
+## 🆘 Support
 
-For more detailed information on all available commands, refer to the [Jira package documentation](./packages/jira/README.md).
+- **GitHub Issues**: For bug reports and feature requests
+- **Discussions**: For questions and community support
 
 ## Project Structure
 
 ```
-
 mcp-devtools/
 ├── core/ # Infrastructure and utility packages
 │ ├── typescript-config/ # Shared TypeScript configuration
@@ -97,7 +99,6 @@ mcp-devtools/
 │ └── jira/ # Jira integration MCP server
 ├── package.json # Root package configuration
 └── pnpm-workspace.yaml # Workspace configuration
-
 ```
 
 ## Development