scrapbox-cosense-mcp

English | 일본어

영어

MCP server for cosense/scrapbox .

Features

• get_page

  • Get page content from cosense/Scrapbox

    • Input: Page title

    • Output: Page content, metadata, links, and editor information

• list_pages

  • Get a list of pages in the project (max 1000 pages)

    • Output: List of page titles in the project

• search_pages

  • Full-text search across all pages in the project (max 100 pages)

    • Supports basic search, AND search, OR search, and NOT search

    • Output: List of page titles in search results

• create_pages

  • Generate page URLs

    • Input: Page title and optional body text

    • Output: URL that can be opened in a browser

개발

Install dependencies:

npm install

Build the server:

npm run build

Auto-rebuild during development:

npm run watch

Installation

git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
cd scrapbox-cosense-mcp
npm install
npm run build

To use with Claude Desktop, add the server configuration as follows:

Mac OS: ~/Library/Application\ Support/Claude/claude_desktop_config.json For Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "scrapbox-cosense-mcp": {
      "command": "npx",
      "args": ["github:worldnine/scrapbox-cosense-mcp"],
      "env": {
        "COSENSE_PROJECT_NAME": "your_project_name",
        "COSENSE_SID": "your_sid", // Required for private projects
        "COSENSE_PAGE_LIMIT": "25", // Optional (default: 100)
        "COSENSE_SORT_METHOD": "created", // Optional (default: "updated")
        "SERVICE_LABEL": "scrapbox(cosense)" // Optional (default: "cosense(scrapbox)")
      }
    }
  }
}

Environment Variables

This server uses the following environment variables:

Required Environment Variables

• COSENSE_PROJECT_NAME : 프로젝트 이름

• COSENSE_SID : Session ID for Scrapbox/Cosense authentication (required for private projects)

Optional Environment Variables

• API_DOMAIN : API domain (default: "scrapbox.io")

• SERVICE_LABEL : Service identifier (default: "cosense (scrapbox)")

• COSENSE_PAGE_LIMIT : Initial page fetch limit (1-1000, default: 100)

• COSENSE_SORT_METHOD : Initial page fetch order (updated/created/accessed/linked/views/title, default: updated)

Environment Variable Behavior

• COSENSE_PROJECT_NAME : Required environment variable. Server will exit with an error if not set.

• COSENSE_SID : Required for accessing private projects. If not set, only public projects are accessible.

• API_DOMAIN :

  • Uses "scrapbox.io" if not set

  • While unverified with domains other than "scrapbox.io" in the author's environment, this option exists in case some environments require "cosen.se"

• COSENSE_PAGE_LIMIT :

  • Uses 100 if not set

  • Uses 100 if value is invalid (non-numeric or out of range)

  • Valid range: 1-1000

• COSENSE_SORT_METHOD :

  • Uses 'updated' if not set

  • Uses 'updated' if value is invalid

  • Does not affect list_pages tool behavior (only used for initial resource fetch)

디버깅

Since MCP servers communicate via stdio, debugging can be challenging. Using MCP Inspector is recommended. You can run it with:

npm run inspector

The Inspector provides a URL to access debugging tools in the browser.

Related MCP server: MCP File System Server

일본어

cosense/scrapbox 용 MCP 서버입니다.

기능

• get_page

  • cosense/Scrapbox에서 페이지 콘텐츠 가져오기

    • 입력: 페이지 제목

    • 출력: 페이지 콘텐츠, 메타데이터, 링크, 편집자 정보

• list_pages

  • 프로젝트 내 페이지 목록 가져오기(최대 1000건)

    • 출력: 프로젝트의 페이지 제목 목록

• search_pages

  • 프로젝트의 전체 페이지를 대상으로 한 전체 텍스트 검색 (최대 100 건)

    • 기본 검색, AND 검색, OR 검색, NOT 검색 지원

    • 출력: 검색 결과 페이지 제목 목록

• create_pages

  • 페이지 URL 생성

    • 입력: 페이지 제목 및 선택적 본문 텍스트

    • 출력: 브라우저에서 열 수 있는 URL

개발 방법

종속성 설치:

npm install

서버 빌드:

npm run build

개발 시 자동 재빌드:

npm run watch

설치 방법

git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
cd scrapbox-cosense-mcp
npm install
npm run build

Claude Desktop에서 사용하려면 다음과 같이 서버 설정을 추가하십시오.

MacOS의 경우: ~/Library/Application\ Support/Claude/claude_desktop_config.json Windows의 경우: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "scrapbox-cosense-mcp": {
      "command": "npx",
      "args": ["github:worldnine/scrapbox-cosense-mcp"],
      "env": {
        "COSENSE_PROJECT_NAME": "your_project_name",
        "COSENSE_SID": "your_sid", // プライベートプロジェクトの場合は必須
        "COSENSE_PAGE_LIMIT": "25", // オプション（デフォルト: 100）
        "COSENSE_SORT_METHOD": "created", // オプション（デフォルト: "updated"）
        "SERVICE_LABEL": "scrapbox(cosense)" // オプション（デフォルト: "cosense(scrapbox)"）
      }
    }
  }
}

환경 변수

이 서버는 다음 환경 변수를 사용합니다.

필수 환경 변수

• COSENSE_PROJECT_NAME : 프로젝트 이름

• COSENSE_SID : Scrapbox/Cosense 인증 세션 ID(개인 프로젝트의 경우 필수)

선택적 환경 변수

• API_DOMAIN : API 도메인(기본값: "scrapbox.io")

• SERVICE_LABEL : 서비스의 고유 이름(기본값: "cosense (scrapbox)")

• COSENSE_PAGE_LIMIT : 초기 획득 시 페이지 수(1-1000, 기본값: 100)

• COSENSE_SORT_METHOD : 초기 취득시의 취득 페이지 순서(updated/created/accessed/linked/views/title, 디폴트: updated)

환경 변수의 거동에 대해서

• COSENSE_PROJECT_NAME : 필수 환경 변수입니다. 설정되지 않은 경우 서버는 시작 시 오류로 종료됩니다.

• COSENSE_SID : 비공개 프로젝트에 액세스하는 데 필요합니다. 설정되지 않은 경우 공용 프로젝트만 액세스할 수 있습니다.

• API_DOMAIN :

  • 미설정 시에는 "scrapbox.io"를 사용

  • 저자의 환경에서는 "scrapbox.io" 이외의 값은 미확인입니다만, "cosen.se"가 아니면 동작하지 않는 환경이 존재할 가능성이 있기 때문에 생각을 위한 옵션입니다.

• COSENSE_PAGE_LIMIT :

  • 미설정 시에는 100을 사용

  • 유효하지 않은 값(수치 이외 또는 범위외)의 경우는 100을 사용

  • 유효 범위: 1-1000

• COSENSE_SORT_METHOD :

  • 미설정 시에는 'updated'를 사용

  • 유효하지 않은 값의 경우 'updated' 사용

  • list_pages 도구의 동작에는 영향을 주지 않습니다(초기 리소스 검색 시에만 사용).

디버깅 방법

MCP 서버는 stdio를 통해 통신하므로 디버깅이 어려울 수 있습니다. MCP Inspector를 사용하는 것이 좋습니다. 다음 명령으로 실행할 수 있습니다.

npm run inspector

Inspector는 브라우저에서 디버깅 도구에 액세스하기 위한 URL을 제공합니다.