Neemee Mcp

io.github.pbonneville由 GitHub 帳號 pbonneville 發布v3.0.2更新於 Oct 24, 2026

MCP client library and bridge for Neemee personal knowledge management system

已驗證STDIO僅桌面效率與工作流知識與記憶

概覽

AI 產生的概覽

一個本機橋接與 TypeScript 用戶端，讓助理連接 Neemee 個人知識管理系統，處理筆記與筆記本。

可以做什麼
建立、更新、刪除和搜尋筆記，支援標題、來源網址、筆記本、frontmatter 以及標籤和日期篩選。建立、更新、刪除和搜尋筆記本。分頁並篩選地列出筆記與筆記本，取得單一筆記或單一筆記本。讀取系統資訊，例如使用統計、健康狀態和最近活動。列出所連接 Neemee 伺服器提供的工具與資源。
適用情境
當你的筆記和研究資料存放在 Neemee，並希望助理在對話中記錄、查找、整理或清理筆記和筆記本時使用。適合 Claude Desktop 等需要透過 STDIO 橋接存取 Neemee 帳戶的本機 MCP 用戶端。
執行需求
以 npm 套件 neemee-mcp 透過 STDIO 在本機執行，需要 Node.js 18 或更新版本。必須提供 Neemee API 金鑰，可透過環境變數 NEEMEE_API_KEY 或 --api-key 參數傳入。選用的 NEEMEE_API_BASE_URL 預設指向 Neemee 託管端點，因此需要網路存取。
安裝前請注意
API 金鑰可存取你的 Neemee 帳戶，請勿寫入共用設定檔或日誌。寫入操作會建立和更新筆記與筆記本，刪除操作會永久移除它們，除非確需修改，否則請使用唯讀權限的金鑰。筆記內容、搜尋和中介資料會傳送到所設定基礎網址的 Neemee 服務。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Neemee Mcp，將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only，透過 STDIO。 STDIO 服務會啟動本機處理程序，因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

Neemee MCP Client Library

A TypeScript client library for connecting to Neemee MCP servers using the official Model Context Protocol SDK.

Overview

This library provides a convenient interface for interacting with Neemee personal knowledge management systems through the Model Context Protocol (MCP). It supports both HTTP and STDIO transport modes and includes full TypeScript support.

Installation

bash
npm install neemee-mcp

Quick Start

HTTP Mode (Web Applications)

typescript
import { NeemeeClient } from 'neemee-mcp';
const client = new NeemeeClient({  transport: 'http',  baseUrl: 'https://neemee.app/mcp',  apiKey: 'your-api-key'});
await client.connect();
// Create a noteconst result = await client.tools.createNote({  content: 'My note content',  title: 'My Note'});
console.log(result);
await client.disconnect();

STDIO Mode (Direct Process Communication)

typescript
import { NeemeeClient } from 'neemee-mcp';
const client = new NeemeeClient({  transport: 'stdio'});
await client.connect();
// Use same API as HTTP modeconst notes = await client.resources.listNotes();console.log(notes);
await client.disconnect();

API Reference

NeemeeClient

Main client class that provides access to tools and resources.

Constructor Options
typescript
interface NeemeeClientOptions {  transport: 'http' | 'stdio';  baseUrl?: string;        // For HTTP mode  apiKey?: string;         // For authentication  timeout?: number;        // Request timeout in milliseconds}
Methods
  • connect(): Promise<void> - Connect to the server
  • disconnect(): Promise<void> - Disconnect from the server
  • listAvailableTools(): Promise<any> - List available MCP tools
  • listAvailableResources(): Promise<any> - List available MCP resources

Tools API

Access via client.tools:

Notes
typescript
// Create a noteawait client.tools.createNote({  content: 'Note content',  title: 'Optional title',  url: 'Optional source URL',  notebook: 'Optional notebook name',  frontmatter: { /* Optional metadata */ }});
// Update a noteawait client.tools.updateNote({  id: 'note-id',  content: 'Updated content',  title: 'Updated title'});
// Delete a noteawait client.tools.deleteNote('note-id', true);
// Search notesawait client.tools.searchNotes({  query: 'search terms',  notebook: 'notebook-name',  domain: 'example.com',  tags: 'tag1,tag2',  startDate: '2024-01-01',  endDate: '2024-12-31',  limit: 50});
Notebooks
typescript
// Create a notebookawait client.tools.createNotebook('Notebook Name', 'Optional description');
// Update a notebookawait client.tools.updateNotebook('notebook-id', 'New Name', 'New description');
// Delete a notebookawait client.tools.deleteNotebook('notebook-id', true);
// Search notebooksawait client.tools.searchNotebooks('search query', 20);

Resources API

Access via client.resources:

Notes
typescript
// List notes with filteringawait client.resources.listNotes({  page: 1,  limit: 20,  search: 'search terms',  domain: 'example.com',  notebook: 'notebook-name',  tags: 'tag1,tag2',  startDate: '2024-01-01',  endDate: '2024-12-31'});
// Get a specific noteawait client.resources.getNote('note-id');
Notebooks
typescript
// List notebooksawait client.resources.listNotebooks({  page: 1,  limit: 20,  search: 'search terms'});
// Get a specific notebookawait client.resources.getNotebook('notebook-id');
System Information
typescript
// Get usage statisticsawait client.resources.getStats();
// Check system healthawait client.resources.getHealth();
// Get recent activityawait client.resources.getRecentActivity();

Error Handling

The library provides specific error types for different failure scenarios:

typescript
import {   NeemeeClientError,  AuthenticationError,  ConnectionError,  NotFoundError,  ValidationError,  ServerError} from 'neemee-mcp';
try {  await client.connect();} catch (error) {  if (error instanceof AuthenticationError) {    console.error('Invalid API key');  } else if (error instanceof ConnectionError) {    console.error('Failed to connect to server');  } else if (error instanceof NeemeeClientError) {    console.error('Client error:', error.message);  }}

Migration from v1.x

Breaking Changes

  • Minimum Node.js version: Now requires Node.js 18.0.0+
  • Constructor options: Format has changed (see Quick Start examples)
  • Error types: Updated error hierarchy
  • Method signatures: Some parameters refined for better type safety

Migration Guide

Old v1.x Usage
typescript
// v1.x (deprecated)const client = new LegacyNeemeeClient({  useStdio: false,  serverUrl: 'https://api.example.com',  apiKey: 'key'});
New v2.x Usage
typescript
// v2.x (recommended)const client = new NeemeeClient({  transport: 'http',  baseUrl: 'https://api.example.com',  apiKey: 'key'});
Legacy Compatibility

For temporary compatibility, use the LegacyNeemeeClient:

typescript
import { LegacyNeemeeClient } from 'neemee-mcp';
// This provides the old API while you migrateconst client = new LegacyNeemeeClient({  useStdio: false,  serverUrl: 'https://api.example.com',  apiKey: 'key'});

Development

Building from Source

bash
git clone https://github.com/Paul-Bonneville-Labs/neemee-mcp.gitcd neemee-mcpnpm installnpm run build

Running Tests

bash
# Test client functionalitynpm run test:client
# Test legacy compatibilitynpm run test:legacy
# Run with mock API servernpm run test:mock-api

Available Scripts

  • npm run build - Compile TypeScript to dist/
  • npm run dev - Run development server with hot reload
  • npm run test:client - Test new client API
  • npm run test:legacy - Test legacy compatibility
  • npm run test:integration - Full integration tests

Examples

Complete Example with Error Handling

typescript
import { NeemeeClient, AuthenticationError, ConnectionError } from 'neemee-mcp';
async function example() {  const client = new NeemeeClient({    transport: 'http',    baseUrl: 'https://neemee.app/mcp',    apiKey: process.env.NEEMEE_API_KEY  });
  try {    await client.connect();        // Create a note    const createResult = await client.tools.createNote({      content: '# My First Note\n\nThis is some content.',      title: 'First Note',      frontmatter: {        tags: ['example', 'test'],        priority: 'high'      }    });        console.log('Created note:', createResult);        // Search for notes    const searchResult = await client.tools.searchNotes({      query: 'first',      tags: 'example',      limit: 10    });        console.log('Found notes:', searchResult);        // List available resources    const resources = await client.listAvailableResources();    console.log('Available resources:', resources);      } catch (error) {    if (error instanceof AuthenticationError) {      console.error('Authentication failed - check your API key');    } else if (error instanceof ConnectionError) {      console.error('Connection failed - check server URL and network');    } else {      console.error('Unexpected error:', error);    }  } finally {    await client.disconnect();  }}
example().catch(console.error);

Tag-Based Search

typescript
// Search notes with multiple tagsconst taggedNotes = await client.tools.searchNotes({  tags: 'work,important,urgent',  notebook: 'Projects',  limit: 25});
// List notes with specific tags via resourcesconst resourceNotes = await client.resources.listNotes({  tags: 'research,ai',  domain: 'arxiv.org',  limit: 50});

Configuration

Claude Desktop Configuration

Use this package as a local bridge for STDIO transport:

json
{  "mcpServers": {    "neemee-local": {      "command": "npx",      "args": ["-y", "neemee-mcp", "--api-key=your-api-key-here"],      "env": {        "NEEMEE_API_BASE_URL": "https://neemee.app/mcp"      }    }  }}

Authentication: Uses API key authentication. Get your API key from Neemee settings. The API key can be provided via the --api-key flag in the args or as a NEEMEE_API_KEY environment variable.

Environment Variables

  • NEEMEE_API_KEY - Your Neemee API key (required for STDIO mode)
  • NEEMEE_API_BASE_URL - Base URL for Neemee API (defaults to https://neemee.app/mcp)

Authentication Scopes

The client supports different permission levels based on your API key:

  • read: Access to resources and search operations
  • write: Create and update operations (includes read)
  • admin: Delete operations (includes write and read)

TypeScript Support

This library is written in TypeScript and provides full type definitions:

typescript
import type {   NeemeeClientOptions,  CreateNoteParams,  UpdateNoteParams,  SearchNotesParams } from 'neemee-mcp';
const options: NeemeeClientOptions = {  transport: 'http',  baseUrl: 'https://api.example.com',  apiKey: 'your-key'};
const noteParams: CreateNoteParams = {  content: 'Note content',  title: 'Note title',  frontmatter: {    tags: ['typescript', 'example'],    date: new Date().toISOString()  }};

License

MIT

Support

來源：README.md，提交 033bf9d

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包，因此其工具未知。

版本歷史

1
  1. v3.0.2最新Sep 16, 2026

評分

已滿足適用檢查項的 40%

該評分衡量此收錄條目的完整程度，依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價，也不表示伺服器安全或目前可用：可連通性是帶日期的檢查結果，評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手；SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭，或保持端點能夠回應探測，以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list，或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分

    請在儲存庫或註冊中心條目中宣告授權條款。