Skip to main content
Glama
README.md
<div align="center">

# `peekmcp`

### Zero-dependency MCP server and CLI that lets AI agents inspect local CSV/JSON/JSONL files without dumping entire files into context.

![License](https://img.shields.io/badge/license-MIT-blue.svg) ![Language](https://img.shields.io/badge/language-python-green.svg) ![Status](https://img.shields.io/badge/status-active-success.svg) ![PyPI](https://img.shields.io/pypi/v/peekmcp) ![Python](https://img.shields.io/badge/python-3.9%2B-blue) ![MCP](https://img.shields.io/badge/MCP-stdio-orange) ![License](https://img.shields.io/badge/license-MIT-green)

<img src="demo.gif" alt="Demo" width="700" />

</div>

---

## 🎯 Why?

Trending repos show heavy investment in MCP, agent context pipelines, and token-efficient tooling, but most file MCP servers expose raw bytes or require databases. Developers frequently have quick CSV/JSON/JSONL artifacts that agents need to inspect without loading entire files into context. PeekMCP fills that gap with a zero-dependency stdio MCP server and CLI that provides schema, samples, and paginated filtered queries.

**Target audience:** AI agent developers, data engineers, and local LLM users who need safe, token-efficient access to flat files during coding, analysis, and automation.

## ✨ Features

- ✨ **Zero-dependency MCP stdio server with list_files, inspect_file, and query_table tools**
- ✨ **CLI for listing, inspecting, and querying CSV/TSV/JSON/JSONL files**
- ✨ **Token-saving pagination, column selection, substring filtering, and truncated cells**

## 🚀 Quick Start

```bash
# Install
pip install peekmcp

# Run
peekmcp --help
```

## 📦 Installation

### From Source

```bash
git clone https://github.com/YOUR_USERNAME/peekmcp.git
cd peekmcp
```

```bash
# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest -v
```

## 🎬 Demo

The GIF above was recorded using [Charm VHS](https://github.com/charmbracelet/vhs):

```bash
vhs < demo.tape
```

## 📖 Usage

```bash
# Show help
peekmcp --help

# Common usage examples
peekmcp --example
```

## 🏗️ Architecture

```mermaid
graph LR
    A[Input] --> B[Core Engine]
    B --> C[Output]
    B --> D[Plugins]
    D --> E[Extensions]
```

## 🤝 Contributing

Contributions are welcome! Please:

1. Fork the repo
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📄 License

MIT © 2026 — See [LICENSE](LICENSE) for details.

---

<div align="center">

**If this project helped you, please ⭐ star it!**

[Made with ❤️ and AI](https://github.com)

</div>