Metadata-Version: 2.4
Name: nwb-mcp-server
Version: 0.1.0
Summary: Add your description here
Author-email: bjhardcastle <ben.hardcastle@alleninstitute.org>
Requires-Python: >=3.10
Requires-Dist: fastmcp>=2.10.4
Requires-Dist: lazynwb>=0.2.71
Description-Content-Type: text/markdown

# NWB Model Context Protocol (MCP) Server

An MCP server for accessing NWB (Neurodata Without Borders) files, providing AI agents access to neuroscience data.

# Features
- 🚀 Rapid exploration of new datasets.
- 🧠 Prompt templates instruct agents to get the most from the tools.
- 💡 "No Code" mode allows analysis without modifying the local filesystem.
- ⚡️ Uses [lazynwb](https://github.com/NeurodataWithoutBorders/lazynwb) for efficient data access across multiple NWB files.
- ☁️ Supports local and cloud data (e.g. on AWS S3).
- 🔒 Read-only access to NWB data.
- 🛠️ Easy setup.

## Requirements

[uv](https://github.com/astral-sh/uv) is used to run the server with required dependencies.


See the [uv installation guide](https://github.com/astral-sh/uv#installation) for platform-specific instructions for a system-wide installation.

Alternatively, install with pip in your system Python environment:

```sh
pip install uv
```

## Configure Copilot Chat

To make the server available in VS Code, create a configuration file at `.vscode/mcp.json` in your
project's root directory.

### Example `.vscode/mcp.json`

```json
{
    "servers": {
        "nwb": { // the name Copilot will use to refer to this server: can be customized
            "command": "uvx",
            "args": [
                "nwb-mcp-server @ git+https://github.com/bjhardcastle/nwb-mcp-server", // will be distributed on PyPI soon
                "--root_dir", "data",       // local or cloud directory containing your NWB files
                "--glob_pattern", "*.nwb"   // pattern to match files (can be applied recursively with `**/*.nwb`)
            ]
        }
    }
}
```
! Check MCP is enabled in settings 
! Update the `--root_dir` and `--glob_pattern` arguments to point to your NWB files.
! Screenshot of mcp.json with start buttons
