|
| 1 | + |
| 2 | +> 注:当前项目为 Serverless Devs 应用,由于应用中会存在需要初始化才可运行的变量(例如应用部署地区、函数名等等),所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用,**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化,详情可参考[部署 & 体验](#部署--体验) 。 |
| 3 | +
|
| 4 | +# start-mcp-flomo 帮助文档 |
| 5 | + |
| 6 | +<description> |
| 7 | + |
| 8 | +Flomo MCP Server |
| 9 | + |
| 10 | +</description> |
| 11 | + |
| 12 | + |
| 13 | +## 资源准备 |
| 14 | + |
| 15 | +使用该项目,您需要有开通以下服务并拥有对应权限: |
| 16 | + |
| 17 | +<service> |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +| 服务/业务 | 权限 | 相关文档 | |
| 22 | +| --- | --- | --- | |
| 23 | +| 函数计算 | AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) | |
| 24 | + |
| 25 | +</service> |
| 26 | + |
| 27 | +<remark> |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +</remark> |
| 32 | + |
| 33 | +<disclaimers> |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +</disclaimers> |
| 38 | + |
| 39 | +## 部署 & 体验 |
| 40 | + |
| 41 | +<appcenter> |
| 42 | + |
| 43 | +- :fire: 通过 [云原生应用开发平台 CAP](https://cap.console.aliyun.com/template-detail?template=start-mcp-flomo) ,[](https://cap.console.aliyun.com/template-detail?template=start-mcp-flomo) 该应用。 |
| 44 | + |
| 45 | +</appcenter> |
| 46 | +<deploy> |
| 47 | + |
| 48 | + |
| 49 | +</deploy> |
| 50 | + |
| 51 | +## 案例介绍 |
| 52 | + |
| 53 | +<appdetail id="flushContent"> |
| 54 | + |
| 55 | +# Flomo MCP Server |
| 56 | + |
| 57 | + |
| 58 | +https://github.com/xianminx/mcp-server-flomo |
| 59 | + |
| 60 | +A Model Context Protocol (MCP) server that lets you create notes in Flomo directly through AI chat interactions in Cursor or Claude desktop. Write and organize your thoughts seamlessly through natural language commands. |
| 61 | + |
| 62 | +## Usage |
| 63 | + |
| 64 | +### Installing via Smithery |
| 65 | + |
| 66 | +To install mcp-server-flomo for Claude Desktop automatically via [Smithery](https://smithery.ai/server/mcp-server-flomo/wss://mcp.smithery.ai:443): |
| 67 | + |
| 68 | +```bash |
| 69 | +npx -y @smithery/cli install mcp-server-flomo --client claude |
| 70 | +``` |
| 71 | + |
| 72 | +### [mcp-get](https://mcp-get.com/) |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +```bash |
| 78 | +npx @michaellatman/mcp-get@latest install mcp-server-flomo |
| 79 | +``` |
| 80 | + |
| 81 | +### [mcp.so](https://mcp.so/server/mcp-server-flomo/xianminx) |
| 82 | +https://mcp.so/protocol/mcp-server-flomo/wss://mcp.smithery.ai:443 |
| 83 | + |
| 84 | +### Manually configure |
| 85 | + |
| 86 | +Configure Claude / Cursor / Windsurf / Cline / ChatWise / Cherry Studio etc. |
| 87 | + |
| 88 | +```bash |
| 89 | +FLOMO_API_URL=your_api_url_here npx mcp-server-flomo |
| 90 | +``` |
| 91 | + |
| 92 | +Or configure for your MCP Host / Client. See https://mcp.so/protocol/mcp-server-flomo/wss://mcp.smithery.ai:443 for configuration detail. |
| 93 | + |
| 94 | +Get your Flomo API URL from [Flomo API Settings](https://v.flomoapp.com/mine) |
| 95 | + |
| 96 | +```json |
| 97 | +{ |
| 98 | + "mcpServers": { |
| 99 | + "mcp-server-flomo": { |
| 100 | + "command": "npx", |
| 101 | + "args": [ |
| 102 | + "mcp-server-flomo" |
| 103 | + ], |
| 104 | + "env": { |
| 105 | + "FLOMO_API_URL": "your_api_url_here" |
| 106 | + } |
| 107 | + } |
| 108 | + } |
| 109 | +} |
| 110 | +``` |
| 111 | + |
| 112 | +Once the server is running, you can create notes in Flomo through natural language commands in your AI chat. Here are some examples: |
| 113 | + |
| 114 | +```json |
| 115 | +"How to publish a mcp server? Could you save the answer to flomo note after answering it" |
| 116 | +``` |
| 117 | + |
| 118 | +This will save the Cursor AI Agent response to Flomo directly in the chat conversation! |
| 119 | + |
| 120 | + |
| 121 | +<img src="https://raw.githubusercontent.com/xianminx/mcp-server-flomo/refs/heads/main/public/images/mcp-cursor-flomo.png" width="400"> |
| 122 | + |
| 123 | +The server will handle: |
| 124 | + |
| 125 | +- Converting your natural language requests into Flomo API calls |
| 126 | +- Proper formatting and submission of your notes |
| 127 | +- Providing feedback on successful note creation |
| 128 | + |
| 129 | +## Dev |
| 130 | + |
| 131 | +1. Get your Flomo API URL from [Flomo API Settings](https://v.flomoapp.com/mine) |
| 132 | + |
| 133 | +2. Install and configure: |
| 134 | + |
| 135 | + ```bash |
| 136 | + # Install dependencies |
| 137 | + npm install |
| 138 | + FLOMO_API_URL=your_api_url_here npx . |
| 139 | + ``` |
| 140 | + |
| 141 | +## Technical Details |
| 142 | + |
| 143 | +- Built with TypeScript and the Model Context Protocol SDK |
| 144 | +- Communicates with Flomo via their REST API |
| 145 | +- Runs over stdio for seamless integration with AI tools |
| 146 | + |
| 147 | +## License |
| 148 | + |
| 149 | +This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details. |
| 150 | + |
| 151 | +</appdetail> |
| 152 | + |
| 153 | + |
| 154 | + |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | +## 使用流程 |
| 160 | + |
| 161 | +<usedetail id="flushContent"> |
| 162 | + |
| 163 | +部署完成拿到 URL 后,准备好支持 SSE 的 MCP Client,通过 SSETransport 进行连接。 |
| 164 | + |
| 165 | +</usedetail> |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | + |
| 174 | + |
0 commit comments