GITHUB_SETUP.md•4.72 kB
# GitHub Setup Instructions
Este documento describe cómo configurar el repositorio en GitHub y publicar el paquete en npm.
## 1. Crear Repositorio en GitHub
### Opción A: Por línea de comando (recomendado)
```bash
# Asegúrate de estar en el directorio del proyecto
cd /Users/diegopacheco/Development/superprecio_mcp
# Inicializar git
git init
# Agregar todos los archivos
git add .
# Hacer el primer commit
git commit -m "Initial commit: Superprecio MCP Server
- Implementado servidor MCP con 6 tools
- Cliente HTTP para Superprecio API
- Resources para información de supermercados
- Prompt de asistente experto en precios
- Documentación completa"
# Crear repositorio en GitHub usando gh CLI
gh repo create superprecio_mcp --public --source=. --remote=origin --push
# O si prefieres privado:
# gh repo create superprecio_mcp --private --source=. --remote=origin --push
```
### Opción B: Manualmente
1. Ve a https://github.com/new
2. Nombre del repositorio: `superprecio_mcp`
3. Descripción: "MCP Server for Superprecio - AI-powered price comparison for Argentina"
4. Selecciona Público o Privado
5. NO agregues README, .gitignore o LICENSE (ya los tenemos)
6. Click "Create repository"
Luego en tu terminal:
```bash
cd /Users/diegopacheco/Development/superprecio_mcp
git init
git add .
git commit -m "Initial commit: Superprecio MCP Server"
git branch -M main
git remote add origin https://github.com/TU_USERNAME/superprecio_mcp.git
git push -u origin main
```
## 2. Configurar el Repositorio
### Agregar Topics
En GitHub, ve a tu repositorio y agrega estos topics:
- `mcp`
- `model-context-protocol`
- `claude`
- `price-comparison`
- `costa-rica`
- `supermarket`
- `typescript`
### Configurar GitHub Actions (Opcional)
Puedes agregar CI/CD más adelante para:
- Build automático
- Tests
- Publicación automática a npm
## 3. Publicar en npm
### Preparación
1. Crea una cuenta en npmjs.com si no tienes una
2. Verifica tu email
3. Login desde la terminal:
```bash
npm login
```
### Verificar antes de publicar
```bash
# Asegúrate de que todo compila
npm run build
# Verifica que los archivos estén correctos
npm pack --dry-run
```
### Publicar
```bash
# Primera publicación
npm publish --access public
# Para actualizaciones futuras:
# 1. Actualiza la versión en package.json
# 2. Commit los cambios
# 3. Crea un tag
git tag v1.0.0
git push origin v1.0.0
# 4. Publica
npm publish
```
## 4. Actualizar README con URLs reales
Una vez creado el repositorio, actualiza el README.md con:
- URL real del repositorio
- Tu username de GitHub
- Badges (opcional):
```markdown
[](https://www.npmjs.com/package/superprecio-mcp)
[](https://opensource.org/licenses/MIT)
```
## 5. Configuración de npm package
El package.json ya está configurado para publicación con:
- ✅ `name`: `superprecio-mcp`
- ✅ `version`: `1.0.0`
- ✅ `description`: Descripción clara
- ✅ `main`: Apunta al archivo compilado
- ✅ `bin`: Permite ejecución con npx
- ✅ `files`: Solo incluye el directorio `build`
- ✅ `keywords`: Para búsqueda en npm
- ✅ `license`: MIT
## 6. Vincular con Superprecio principal
En el README del proyecto principal de Superprecio, agrega:
```markdown
## MCP Server
Superprecio tiene un servidor MCP que permite integración con Claude y otros asistentes AI:
[superprecio_mcp](https://github.com/TU_USERNAME/superprecio_mcp)
Instalación:
\`\`\`bash
npx superprecio-mcp
\`\`\`
```
## 7. Checklist de Publicación
Antes de la primera publicación:
- [ ] Compilación exitosa (`npm run build`)
- [ ] README completo y sin TODOs
- [ ] LICENSE presente
- [ ] .gitignore configurado
- [ ] package.json con info correcta
- [ ] Código versionado en GitHub
- [ ] Tests si tienes (opcional)
- [ ] Variables de entorno documentadas
## 8. Versionado Semántico
Para futuras actualizaciones:
- **PATCH** (1.0.X): Bug fixes
```bash
npm version patch
```
- **MINOR** (1.X.0): Nuevas features (backward compatible)
```bash
npm version minor
```
- **MAJOR** (X.0.0): Breaking changes
```bash
npm version major
```
Luego:
```bash
git push origin main --tags
npm publish
```
## 9. Mantener Actualizado
Cuando actualices Superprecio API:
1. Actualiza el cliente en `src/client/superPrecioApi.ts`
2. Agrega nuevos tools si hay nuevos endpoints
3. Actualiza la versión
4. Publica nueva versión en npm
## 10. Promoción
Una vez publicado:
- [ ] Tweet/post en redes sociales
- [ ] Agregar a https://github.com/modelcontextprotocol/servers
- [ ] Post en foros de Claude/Anthropic
- [ ] Documentar en blog/Medium