Skip to content

TaylorChen/flomo-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flomo-mcp MCP Server

flomo-mcp

一个基于 MCP(Model Context Protocol)的服务,将文本快速发布到 flomo。

功能特性

  • 提供 write_note 工具:把文本作为一条 flomo 笔记发布
  • 提供资源/提示示例:示例 notes 资源、summarize_notes 提示

安装与构建

  1. 克隆仓库
  2. 安装依赖:npm install
  3. 构建:npm run build

配置

  • 以环境变量或启动参数设置 Flomo Webhook:
    • 环境变量:FLOMO_API_URL="https://flomoapp.com/iwh/xxx/yyy/"
    • 启动参数:--flomo_api_url=https://flomoapp.com/iwh/xxx/yyy/

在 Cursor 中使用

  1. 打开 ~/.cursor/mcp.json,新增:
{
  "mcpServers": {
    "flomo-mcp": {
      "command": "/absolute/path/to/node",
      "args": ["/absolute/path/to/flomo-mcp/build/index.js"],
      "env": {
        "FLOMO_API_URL": "https://flomoapp.com/iwh/xxx/yyy/"
      }
    }
  }
}
  1. 在 Cursor 侧边栏 MCP 中启用 flomo-mcp
  2. 调用工具 write_note,传入:
{ "content": "今天开发了一个 MCP 服务器,很开心记录一下" }

本地调试(可选)

  • 运行 Inspector:npm run inspector
  • 交互测试资源、提示与工具

许可协议

  • 本项目使用 MIT License,详见 LICENSE

贡献

  • 欢迎 PR/Issue,提交前请:
    • 代码通过 npm run build
    • 不要提交 build/node_modules/、私密信息

write notes to flomo

This is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing:

  • Resources representing text notes with URIs and metadata
  • Tools for creating new notes
  • Prompts for generating summaries of notes

Features

Resources

  • List and access notes via note:// URIs
  • Each note has a title, content and metadata
  • Plain text mime type for simple content access

Tools

  • create_note - Create new text notes
    • Takes title and content as required parameters
    • Stores note in server state

Prompts

  • summarize_notes - Generate a summary of all stored notes
    • Includes all note contents as embedded resources
    • Returns structured prompt for LLM summarization

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "flomo-mcp": {
      "command": "/path/to/flomo-mcp/build/index.js"
    }
  }
}

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.

About

An MCP (Model Context Protocol) server to quickly post text notes to flomo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published