NebulaBlock API MCP

1# NebulaBlock API MCP
2 
3This repository hosts the official NebulaBlock API Model Context Protocol (MCP) server. This server integrates with the `fastmcp` library to expose the full range of NebulaBlock API functionalities as accessible tools, enabling seamless and efficient interaction within any MCP-compatible environment.
4 
5## Project Structure
6 
7```
8.
9├── src/
10│   ├── __init__.py
11│   ├── config.py
12│   ├── main.py
13│   ├── tools.py
14│   └── mcp_project.egg-info/
15├── tests/
16│   ├── __init__.py
17│   └── test_main.py
18├── scripts/
19├── docs/
20├── .env.example
21├── .gitignore
22├── pyproject.toml
23├── README.md
24└── uv.lock
25```
26 
27*   `src/`: Contains the main application source code, including configuration and tool definitions.
28*   `tests/`: Contains unit and integration tests.
29*   `scripts/`: Reserved for utility scripts (e.g., setup, data generation).
30*   `docs/`: Reserved for supplementary documentation.
31*   `.env.example`: Example file for environment variables.
32*   `.gitignore`: Specifies intentionally untracked files to ignore.
33*   `pyproject.toml`: Project metadata and build system configuration, including dependencies and project information.
34*   `README.md`: This documentation file.
35*   `uv.lock`: Lock file for `uv` dependency management.
36 
37## Installation and Setup
38 
39To set up and run this project, follow these steps:
40 
411.  **Clone the repository (if applicable):**
42    ```bash
43    git clone https://github.com/Nebula-Block-Data/api-mcp
44    cd mcp-project
45    ```
46 
472.  **Create a virtual environment:**
48    It's highly recommended to use a virtual environment to manage project dependencies.
49    ```bash
50    python3 -m venv .venv
51    ```
52 
533.  **Activate the virtual environment:**
54    *   **macOS/Linux:**
55```bash
56source .venv/bin/activate
57```
58 
594.  **Install dependencies:**
60    This project uses `pyproject.toml` for dependency management. Install `setuptools` and then the project in editable mode.
61    ```bash
62    uv pip install -e .
63    ```
64    This will install `fastmcp` and any other dependencies specified in `pyproject.toml`.
65 
66## Running the NebulaBlock API MCP Server
67 
68To start the NebulaBlock API MCP server:
69 
70```bash
71uv run -m src.main
72```
73 
74You should see output similar to: `[05/29/25 17:32:58] INFO     Starting MCP server 'FastMCP' with transport 'stdio'`
75 
76### Configuring API Key
77 
78The NebulaBlock API key can be configured in two ways:
79 
801.  **Using the `--api-key` command-line argument:**
81    You can provide the API key directly when running the application:
82    ```bash
83    python -m src.main --api-key your_nebula_block_api_key
84    ```
85    This method will override any API key set in the `.env` file.
86 
872.  **Using a `.env` file:**
88    Create a file named `.env` in the root directory of the project and add your API key to it:
89    ```
90    NEBULA_BLOCK_API_KEY=your_nebula_block_api_key
91    ```
92    The application will automatically load the API key from this file if the `--api-key` argument is not provided.
93 
94## Running Tests
95 
96To run the unit tests, ensure your virtual environment is activated and `pytest` is installed (it will be installed with `pip install -e .`):
97 
98```bash
99pytest
100```
101 
102You should see output indicating that the tests passed.
103 
104## Integrating with an MCP Client
105 
106To utilize the NebulaBlock API MCP server, you need to configure your MCP client (e.g., VS Code with an MCP extension) to connect to this server. Below is an example configuration for a `settings.json` file:
107 
108```json
109{
110  "mcpServers": {
111    "nebula": {
112      "command": "~/path/to/uv",
113      "args": [
114        "--directory",
115        "~/path/to/nebulablock_mcp",
116        "run",
117        "-m",
118        "src.main",
119        "--api-key=YOUR_API_KEY"
120      ]
121    }
122  }
123}
124```
125 
126*   Replace `~/path/to/uv` with the actual path to your `uv` executable.
127*   Replace `~/path/to/nebulablock_mcp` with the actual path to your project directory.
128*   Replace `YOUR_API_KEY` with your actual NebulaBlock API key.
129 
130## License
131 
132This project is licensed under the MIT License. See the `LICENSE` file (if created) for details.