Skip to main content
Glama
bb-sdk

bitbank-api MCP Server

by bb-sdk
README.md
# @pokooo/bb-api-mcp

> [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for [bitbank-api](https://github.com/poko/bitbank-api) — exposes the TypeScript SDK source to AI assistants via tools and resources.

[![npm](https://img.shields.io/npm/v/@pokooo/bb-api-mcp)](https://www.npmjs.com/package/@pokooo/bb-api-mcp)
[![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
[![pnpm](https://img.shields.io/badge/packageManager-pnpm-orange)](https://pnpm.io)

---

## Tools

| Tool | Description |
|------|-------------|
| `list_sdk_files` | List all TypeScript source files in the bitbank-api SDK |
| `get_sdk_file` | Return the full content of a specific SDK source file |
| `search_sdk` | Search across all SDK source files for a keyword (case-insensitive, with file name and line number) |
| `get_api_overview` | Return a structured overview of all client classes and their public methods |

## Resources

| URI | Description |
|-----|-------------|
| `bitbank-api://overview` | Structured summary of all SDK clients and their methods |
| `bitbank-api://source/<path>` | Raw content of an individual SDK source file |

---

## Installation

```bash
pnpm install
pnpm build
```

**Requirements:** Node.js 18+, and the `bitbank-api` repository cloned locally.

---

## Quick Start

By default the server looks for the SDK at `../bitbank-api/src` relative to this package. Override with an environment variable:

```bash
export BITBANK_API_SRC_PATH=/path/to/bitbank-api/src
node dist/index.js
```

---

## Claude Desktop

Add the following to `~/Library/Application Support/Claude/claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "bb-api-mcp": {
      "command": "node",
      "args": ["/path/to/bb-api-mcp/dist/index.js"],
      "env": {
        "BITBANK_API_SRC_PATH": "/path/to/bitbank-api/src"
      }
    }
  }
}
```

---

## Configuration

| Environment Variable | Default | Description |
|----------------------|---------|-------------|
| `BITBANK_API_SRC_PATH` | `../bitbank-api/src` | Absolute path to the `bitbank-api` SDK `src` directory |

---

## Development

```bash
pnpm dev    # Watch mode (tsc --watch)
pnpm build  # Compile TypeScript
pnpm start  # Start the server
```

---

## License

[MIT](LICENSE)