Miro API 및 단일 보드와 상호 작용하는 실험 모델 제어 프로토콜 (MCP) 서버.

개요

이 프로젝트는 AI 에이전트에 의해 사용할 수있는 도구로 Miro API 엔드포인트를 노출하는 FastMCP 서버를 제공합니다. Miro OpenAPI 사양의 도구 정의를 자동으로 생성합니다. AI 에이전트가 Miro 보드 프로그래밍을 조작 할 수 있습니다.

특징

• 모든 주요 Miro 보드 항목 유형 지원 :
• 끈끈한 노트
• 모양
• 텍스트
• 이미지
• 카드
• 앱 카드
• 문서
• 엠베드
• 연결관

필수품

• 노드.js
• API 액세스가있는 Miro 계정
• Miro API 토큰
• 미로 보드 ID

Docker 없이 임명

1. 저장소를 복제:

2. 의존성 설치:

3. 다음 변수와 루트 디렉토리에 .env 파일을 만듭니다.

사용법

1. 서버 시작:

또는

2. 서버는 http://localhost:8899/sse에서 시작합니다

3. AI 대리인은 지금 MCP 의정서를 통해 드러낸 Miro API 공구를 이용할 수 있습니다

Docker 사용

API 도구

서버는 도구로 다음 Miro API 엔드포인트를 노출시킵니다.

보드 운영:

• get_specific_board: 현재 게시판에 대한 정보를 검색합니다.

Miro MCP Server

An experimental Model Control Protocol (MCP) server for interacting with the Miro API and a single board.

Overview

This project provides a FastMCP server that exposes Miro API endpoints as tools that can be used by AI agents. It automatically generates tool definitions from the Miro OpenAPI specification, allowing AI agents to manipulate Miro boards programmatically.

Features

• Support for all major Miro board item types:
  • Sticky notes
  • Shapes
  • Text
  • Images
  • Cards
  • App cards
  • Documents
  • Embeds
  • Connectors

Prerequisites

• Node.js
• A Miro account with API access
• A Miro API token
• A Miro board ID

Installation without Docker

1. Clone the repository:

   git clone https://github.com/yourusername/mcp-server-miro.git
   cd mcp-server-miro
   

2. Install dependencies:

   npm install
   

3. Create a .env file in the root directory with the following variables:

   MIRO_API_TOKEN=your_miro_api_token
   MIRO_BOARD_ID=your_miro_board_id
   
   # Optional, port
   PORT=3000
   

Usage

1. Start the server:

   npm run dev
   

   or

   npm run build
   npm start
   

2. The server will start at http://localhost:8899/sse

3. AI agents can now use the exposed Miro API tools through the MCP protocol

Using with Docker

# The exact command depends on your Docker version
docker compose up -d
docker-compose up -d

# Server should be up in default port or the one you chose

API Tools

The server exposes the following Miro API endpoints as tools:

Board Operations:

• get_specific_board: Retrieves information about the current board.
• update_board: Updates the current board.

Generic Item Operations:

• get_items: Retrieves a list of items on the board (supports filtering and pagination).
• update_item_position_or_parent: Updates the position or parent of a specific item.
• delete_item: Deletes a specific item (covers various types like sticky notes, text, shapes, etc.).

Sticky Note Operations:

• create_sticky_note_item: Adds a sticky note.
• get_sticky_note_item: Retrieves a specific sticky note.
• update_sticky_note_item: Updates a specific sticky note.

Text Operations:

• create_text_item: Adds a text item.
• get_text_item: Retrieves a specific text item.
• update_text_item: Updates a specific text item.

Shape Operations:

• create_shape_item: Adds a shape item.
• get_shape_item: Retrieves a specific shape item.
• update_shape_item: Updates a specific shape item.

Card Operations:

• create_card_item: Adds a card item.
• get_card_item: Retrieves a specific card item.
• update_card_item: Updates a specific card item.

Connector Operations:

• create_connector: Adds a connector between items.
• get_connectors: Retrieves a list of connectors.
• get_connector: Retrieves a specific connector.
• update_connector: Updates a specific connector.