Freelo MCP Server

弗里洛·麦克普

使用MCP框架构建的模型上下文协议（MCP）服务器，提供与 弗里洛 API项目管理。

特性

此MCP服务器公开了与Freelo任务、子任务和文件交互的工具：

• freelo_get_task -获取任务的详细信息，包括注释和附件
• freelo_list_task_subtasks -列出所有具有完成状态的子任务
• freelo_download_file -使用UUID从任务注释下载文件

快速开始

1.获取您的Freelo API密钥

1. 登录到您的 Freelo仪表板
2. 点击右上角的头像→ 设置
3. 滚动到底部找到您的 API密钥

2.添加到克劳德代码

claude mcp add freelo-mcp -e FREELO_EMAIL=your-email@example.com -e FREELO_API_KEY=your-api-key -- npx -y @liquiddesign/freelo-mcp

就是这样！您现在可以在Claude Code中使用Freelo工具。

替代设置

克劳德代码（手册）

添加到MCP设置(~/.claude/settings.json 或项目 .mcp.json):

{
  "mcpServers": {
    "freelo-mcp": {
      "command": "npx",
      "args": ["-y", "@liquiddesign/freelo-mcp"],
      "env": {
        "FREELO_EMAIL": "your-email@example.com",
        "FREELO_API_KEY": "your-api-key-here"
      }
    }
  }
}

克劳德桌面版

添加到Claude Desktop配置文件：

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json 视窗: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "freelo-mcp": {
      "command": "npx",
      "args": ["-y", "@liquiddesign/freelo-mcp"],
      "env": {
        "FREELO_EMAIL": "your-email@example.com",
        "FREELO_API_KEY": "your-api-key-here"
      }
    }
  }
}

发展

# Install dependencies
npm install

# Build the project
npm run build

# Watch mode during development
npm run watch

对于本地开发，配置Claude直接使用构建的项目：

{
  "mcpServers": {
    "freelo-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/freelo-mcp/dist/index.js"],
      "env": {
        "FREELO_EMAIL": "your-email@example.com",
        "FREELO_API_KEY": "your-api-key-here"
      }
    }
  }
}

项目结构

freelo-mcp/
├── src/
│   ├── tools/                           # MCP Tools
│   │   ├── FreeloGetTask.ts             # Get task details with comments & files
│   │   ├── FreeloListTaskSubtasks.ts    # List task subtasks
│   │   └── FreeloDownloadFile.ts        # Download files by UUID
│   ├── utils/
│   │   └── freeloApi.ts                 # Freelo API client & types
│   └── index.ts                         # Server entry point
├── package.json
├── tsconfig.json
└── CLAUDE.md                            # Claude Code instructions

可用工具

1.freelo_get_task

获取有关特定Freelo任务的详细信息，包括所有注释和附件。

参数：

• taskId （number）-任务的唯一ID

退货：

• 任务名称、描述、优先级、状态
• 作者和受让人信息
• 日期（创建、到期、完成）
• 项目和任务列表详细信息
• 标签和时间估计
• 带有内容、作者、时间戳和附加文件（带UUID）的注释

例子：

Use freelo_get_task with taskId: 12345

2.freelo_list_task_subtasks

列出特定任务的所有子任务及其完成统计信息。

参数：

• taskId （number）-任务的唯一ID

退货：

• 包含名称、状态、日期、作者、受让人的子任务数组
• 统计数据（总计、已完成、剩余、完成百分比）

例子：

Use freelo_list_task_subtasks with taskId: 12345

3.freelo_download_file

使用其UUID从Freelo下载文件。在任务注释中可以找到文件UUID（使用 freelo_get_task 第一）。

参数：

• fileUuid （string）-文件的UUID（来自任务注释）
• filename （字符串，可选）-要另存为的自定义文件名

退货：

• 下载的文件路径（在系统临时目录中）
• 文件元数据（UUID、文件名、大小）

例子：

Use freelo_download_file with fileUuid: "550e8400-e29b-41d4-a716-446655440000"

添加新工具

您可以使用其他Freelo API工具扩展此MCP服务器：

# Add a new tool using mcp-framework CLI
mcp add tool my-tool

# Examples of additional Freelo tools you might create:
# - freelo_list_projects
# - freelo_create_task
# - freelo_add_comment

工具开发

工具结构示例：

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool {
  name = "my_tool";
  description = "Describes what your tool does";

  schema = {
    message: {
      type: z.string(),
      description: "Description of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Your tool logic here
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

发布到npm

1. 更新你的package.json：

- 确保 name 是唯一的，遵循npm命名约定 - 设置适当 version - 添加 description, author, license等等。 - 检查 bin 指向正确的条目文件

1. 在本地构建和测试：

   npm run build
   npm link
   freelo-mcp  # Test your CLI locally

1. 登录npm（必要时创建帐户）：

   npm login

1. 发布您的包：

   npm publish

发布后，用户可以将其添加到他们的Claude Desktop客户端（见下文）或使用npx运行它。

使用Claude Desktop

构建项目并配置凭据后（请参阅 Freelo API设置)，重新启动Claude Desktop以加载MCP服务器。

然后，您可以在与Claude的对话中使用Freelo工具：

对话示例：

You: "Get details for Freelo task 12345"
Claude: [Uses freelo_get_task tool and returns task info with comments and files]

You: "Show me the subtasks"
Claude: [Uses freelo_list_task_subtasks tool and displays subtasks]

You: "Download the first file attachment"
Claude: [Uses freelo_download_file with the UUID from the task comments]

建造和测试

1. 对工具进行更改
2. 跑 npm run build 编写
3. 服务器将在启动时自动加载您的工具

了解更多

MCP框架

• MCP框架文件
• 模型上下文协议

弗里洛API

• Freelo API文档 -API官方参考
• Freelo API帮助 -如何获取API密钥
• Freelo网站 -项目管理平台

api参考

此MCP服务器使用Freelo REST API v1:

• 基本URL: https://api.freelo.io/v1
• 认证：HTTP基本身份验证（电子邮件：apiKey）
• 响应格式：JSON
• 当前支持：只读操作（GET端点）

有关API的详细规范，请参阅 Freelo API官方文档.

贡献

这是Freelo API集成的个人项目。您可以使用其他工具或改进来扩展它。

许可证

麻省理工学院