Peekaboo

Provides read-only access to a project for AI agents, with controlled modification scope to a chosen workspace.

javascript

0

GitHub Stars

javascript

Language

3 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "davstr1-peekaboomcp": {
      "command": "npx",
      "args": [
        "peekaboo-mcp"
      ],
      "env": {
        "PEEKABOO_MAX_DEPTH": "10",
        "PEEKABOO_RECURSIVE": "true"
      }
    }
  }
}

Peekaboo-mcp provides a strict read-only MCP server that lets AI tools see your codebase while only allowed to modify files you open in a dedicated workspace. This keeps context intact for the AI while preventing unwanted changes to your project.

How to use

You connect an MCP client to the Peekaboo MCP server to give the AI access to your codebase without exposing your entire project to edits. Run the server from your project and configure your client so it launches or connects to this MCP endpoint when you start your AI tool. You can open only the specific folder you want the AI to work on, while the AI can read the whole project for context.

How to install

Prerequisites: you need Node.js and npm installed on your system.

Step by step install and run from your project root.

# 1) Install in your project root
npm install peekaboo-mcp

# 2) Start the standalone MCP server (from the project root)
npx peekaboo-mcp

# Optional: disable recursive listing and set depth via environment variables
PEEKABOO_RECURSIVE=false npx peekaboo-mcp
PEEKABOO_MAX_DEPTH=5 npx peekaboo-mcp

# 3) If you want to use it as a module inline in your code
# (see internal APIs for integration in your environment)

Configuration and security

This MCP server reads from your project root where it is installed and never accesses files outside that project. It enforces strict read-only access and blocks path traversal beyond the root. You control which folder the AI can modify by opening a specific workspace folder.

Environment variables you can use to tailor behavior:

PEEKABOO_RECURSIVE
PEEKABOO_MAX_DEPTH

Example client configuration

Use a local, stdio-based MCP connection so your AI tool launches Peekaboo and communicates over standard input/output.

{"mcpServers": {"peekaboo": {"command": "npx", "args": ["peekaboo-mcp"]}}}

Tools and capabilities

The MCP server can list directory contents recursively, read file contents with MIME type detection, and search files by name or content while ensuring strict read-only access and safe path handling.

Available tools

List Resources

Return all files and directories from the configured root, recursive by default.

Read Resource

Return the content of a specific file, with its MIME type detected.

search_path

Search for files and directories by name pattern supporting wildcards (e.g., *.ts, src/**/*.js).

search_content

Search for text within files with optional file pattern filtering and line-number results.