{"_id":"@247arjun/mcp-jq","name":"@247arjun/mcp-jq","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@247arjun/mcp-jq","version":"1.0.0","description":"An MCP Server that wraps the jq command-line utility for JSON querying","main":"build/index.js","types":"build/index.d.ts","type":"module","bin":{"mcp-jq":"build/index.js"},"repository":{"type":"git","url":"git+https://github.com/247arjun/mcp-jq.git"},"homepage":"https://github.com/247arjun/mcp-jq#readme","bugs":{"url":"https://github.com/247arjun/mcp-jq/issues"},"scripts":{"build":"tsc","dev":"tsc --watch","start":"node build/index.js","test":"node test.js","validate":"node test.js","clean":"rm -rf build","prepare":"npm run build"},"keywords":["mcp","model-context-protocol","jq","json","query","claude","ai-tools"],"author":{"name":"247arjun"},"license":"MIT","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"devDependencies":{"@types/node":"^20.0.0","typescript":"^5.0.0"},"engines":{"node":">=18.0.0"},"_id":"@247arjun/mcp-jq@1.0.0","gitHead":"17fe7b5fda323d234aaf934e647b3378f4e426ce","_nodeVersion":"24.4.1","_npmVersion":"11.4.2","dist":{"integrity":"sha512-1AlsiFzsLS0ti310D/GZxBKjudpAemI28mIUPH+hKmIg6KsUzinLQhiSQcNoHi1aem2dHFOTwYJJ+8wId6lidQ==","shasum":"7a10820eb46b3330c750191a80e7489161e6e556","tarball":"https://registry.npmjs.org/@247arjun/mcp-jq/-/mcp-jq-1.0.0.tgz","fileCount":10,"unpackedSize":29598,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCKld3OyN3XnBN+c1qJ35c6Uza2oGWXHe78g6TSRIqybgIgJH16/I0JVOy0The7eKLo9NahRBtlWVidICMiV4516Tc="}]},"_npmUser":{"name":"247arjun","email":"247arjun@gmail.com"},"directories":{},"maintainers":[{"name":"247arjun","email":"247arjun@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-jq_1.0.0_1753565464315_0.25938532140563764"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-26T21:31:04.154Z","1.0.0":"2025-07-26T21:31:04.501Z","modified":"2025-07-26T21:31:04.903Z"},"maintainers":[{"name":"247arjun","email":"247arjun@gmail.com"}],"description":"An MCP Server that wraps the jq command-line utility for JSON querying","homepage":"https://github.com/247arjun/mcp-jq#readme","keywords":["mcp","model-context-protocol","jq","json","query","claude","ai-tools"],"repository":{"type":"git","url":"git+https://github.com/247arjun/mcp-jq.git"},"author":{"name":"247arjun"},"bugs":{"url":"https://github.com/247arjun/mcp-jq/issues"},"license":"MIT","readme":"# @247arjun/mcp-jq\n\n[![CI](https://github.com/247arjun/mcp-jq/workflows/CI/badge.svg)](https://github.com/247arjun/mcp-jq/actions)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)\n\nAn MCP (Model Context Protocol) server that provides a wrapper around the `jq` command-line utility for querying JSON data.\n\n## Features\n\n- Query JSON files using jq syntax\n- Parse and format JSON data\n- Support for complex jq filters and operations\n- Stream processing for large JSON files\n\n## Prerequisites\n\n- Node.js 18 or higher\n- `jq` command-line utility installed on your system\n\n### Installing jq\n\n**macOS:**\n```bash\nbrew install jq\n```\n\n**Ubuntu/Debian:**\n```bash\nsudo apt-get install jq\n```\n\n**Windows:**\nDownload from https://jqlang.github.io/jq/download/\n\n## Quick Start\n\n1. **Install dependencies:**\n   ```bash\n   npm install\n   ```\n\n2. **Build the project:**\n   ```bash\n   npm run build\n   ```\n\n3. **Run tests:**\n   ```bash\n   npm test\n   ```\n\n4. **Start the server:**\n   ```bash\n   npm start\n   ```\n\nAlternatively, use the installation script:\n```bash\nchmod +x install.sh && ./install.sh\n```\n\n## Installation from npm\n\nYou can also install the package directly from npm:\n\n```bash\nnpm install -g @247arjun/mcp-jq\n```\n\nThen run with:\n```bash\nmcp-jq\n```\n\n## MCP Client Configuration\n\nAdd this to your MCP client configuration (e.g., Claude Desktop):\n\n```json\n{\n  \"mcpServers\": {\n    \"jq\": {\n      \"command\": \"node\",\n      \"args\": [\"/absolute/path/to/mcp-jq/build/index.js\"],\n      \"description\": \"JSON querying with jq\"\n    }\n  }\n}\n```\n\n## Documentation\n\n- **[EXAMPLES.md](EXAMPLES.md)** - Usage examples and advanced jq queries\n- **[INTEGRATION.md](INTEGRATION.md)** - Detailed integration guide for MCP clients\n\n## Project Structure\n\n```\nmcp-jq/\n├── src/\n│   └── index.ts          # Main server implementation\n├── build/                # Compiled JavaScript (after build)\n├── examples/             # Sample JSON files for testing\n│   ├── users.json\n│   └── company.json\n├── package.json          # Project dependencies and scripts\n├── tsconfig.json         # TypeScript configuration\n├── install.sh           # Installation script\n├── test.js              # Test script\n└── README.md            # This file\n```\n\n## Available Tools\n\nThe server exposes the following tools:\n\n### `jq_query`\nQuery JSON data using jq syntax.\n\n**Parameters:**\n- `json_data` (string): The JSON data to query\n- `filter` (string): The jq filter expression\n- `raw_output` (boolean, optional): Return raw output instead of JSON\n\n### `jq_query_file`\nQuery a JSON file using jq syntax.\n\n**Parameters:**\n- `file_path` (string): Path to the JSON file\n- `filter` (string): The jq filter expression\n- `raw_output` (boolean, optional): Return raw output instead of JSON\n\n### `jq_format`\nFormat and prettify JSON data.\n\n**Parameters:**\n- `json_data` (string): The JSON data to format\n\n### `jq_validate`\nValidate if a string is valid JSON.\n\n**Parameters:**\n- `json_data` (string): The JSON data to validate\n\n### `jq_keys`\nGet all keys from a JSON object or array of objects.\n\n**Parameters:**\n- `json_data` (string): The JSON data to extract keys from\n- `recursive` (boolean, optional): Get keys recursively (default: false)\n\n## Development\n\nRun in development mode with auto-rebuild:\n```bash\nnpm run dev\n```\n\n## Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature/your-feature`\n3. Make your changes and add tests\n4. Run tests: `npm test`\n5. Commit your changes: `git commit -am 'Add some feature'`\n6. Push to the branch: `git push origin feature/your-feature`\n7. Create a Pull Request\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for version history and changes.\n\n## License\n\nMIT - see [LICENSE](LICENSE) for details.\n\n## Support\n\n- 📖 [Documentation](https://github.com/247arjun/mcp-jq#readme)\n- 🐛 [Bug Reports](https://github.com/247arjun/mcp-jq/issues/new?template=bug_report.yml)\n- 💡 [Feature Requests](https://github.com/247arjun/mcp-jq/issues/new?template=feature_request.yml)\n- 💬 [Discussions](https://github.com/247arjun/mcp-jq/discussions)\n","readmeFilename":"README.md","_rev":"1-f5d37613772c334524b1cc4b400fdccf"}