UNPKG

@ildunari/jina-mcp-advanced

Version:

Pure MCP Server for Jina.AI Advanced web scraping

140 lines (110 loc) 3.71 kB
# Jina MCP Advanced Package - Project Summary ## 🎉 Project Successfully Created! I've created a complete npm package called `@ildunari/jina-mcp-advanced` that serves as an MCP server for Jina.AI's web scraping capabilities. ## 📁 Files Created 1. **`package.json`** - NPM package configuration with all dependencies 2. **`index.js`** - Main server implementation (executable) 3. **`README.md`** - Quick start documentation 4. **`DOCUMENTATION.md`** - Comprehensive documentation 5. **`LICENSE`** - MIT license file 6. **`test.js`** - Test script for verifying functionality 7. **`.gitignore`** - Git ignore patterns 8. **`.github/workflows/publish.yml`** - GitHub Actions for automated publishing ## ✅ What I've Done 1. ✓ Created complete npm package structure 2. ✓ Implemented full Jina Reader API functionality 3. ✓ Made the package executable via npx 4. ✓ Added command-line argument handling 5. ✓ Created health check and OpenAPI endpoints 6. ✓ Initialized git repository 7. ✓ Added remote origin for GitHub 8. ✓ Installed npm dependencies 9. ✓ Created comprehensive documentation 10. ✓ Added test scripts 11. ✓ Set up GitHub Actions workflow ## 🚀 Next Steps ### 1. Create GitHub Repository Since the token doesn't have permission to create repos, you'll need to: 1. Go to https://github.com/new 2. Create a new repository named `jina-mcp-advanced` 3. Make it public 4. Don't initialize with README (we already have one) ### 2. Push to GitHub Once the repository is created: ```bash cd /Users/kosta/Documents/ProjectsCode/Jina_MCP_Advanced git push -u origin main ``` ### 3. Publish to NPM ```bash # Login to npm (if not already) npm login # Publish the package npm publish --access public ``` ### 4. Test the Published Package ```bash # Test with npx npx @ildunari/jina-mcp-advanced --apiKey YOUR_API_KEY # Test with MCP client claude mcp add jina 'npx @ildunari/jina-mcp-advanced@latest --headless --apiKey YOUR_API_KEY' ``` ## 🔧 Usage Examples ### Command Line ```bash # Basic usage npx @ildunari/jina-mcp-advanced --apiKey YOUR_API_KEY # Custom port npx @ildunari/jina-mcp-advanced --port 8080 --apiKey YOUR_API_KEY # Headless mode npx @ildunari/jina-mcp-advanced --headless --apiKey YOUR_API_KEY ``` ### API Request ```bash curl -X POST http://localhost:3000/api/jina/read \ -H "Content-Type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ -d '{ "url": "https://example.com", "return_format": "markdown" }' ``` ### MCP Configuration ```json { "mcpServers": { "Jina-MCP-Advanced": { "command": "npx", "args": [ "@ildunari/jina-mcp-advanced@latest", "--headless", "--apiKey", "YOUR_API_KEY" ] } } } ``` ## 📋 Checklist - [x] Package structure created - [x] Server implementation complete - [x] Documentation written - [x] Git repository initialized - [x] Dependencies installed - [x] Test scripts created - [x] GitHub Actions configured - [ ] GitHub repository created (manual step required) - [ ] Code pushed to GitHub - [ ] Package published to npm - [ ] Package tested via npx ## 🔗 Important Links - NPM Package: https://www.npmjs.com/package/@ildunari/jina-mcp-advanced (after publishing) - GitHub Repository: https://github.com/ildunari/jina-mcp-advanced (after creating) - Jina Documentation: https://jina.ai/reader/ ## 💡 Tips 1. Always test locally before publishing 2. Update version numbers following semantic versioning 3. Keep documentation up to date 4. Add more tests as features grow 5. Consider adding TypeScript types in future versions The package is ready to be published! Just complete the GitHub and NPM publishing steps above.