Token导航 LogoToken导航TokenDH.com
Pf MCP Server Local logo
AI代理未说明官方级别未说明来源级核验

Pf MCP Server Local

MCP Server

Planfix MCP Server是一个模型上下文协议服务器,提供与Planfix项目管理平台的无缝集成,使AI助手能够通过标准化接口与Planfix任务交互。

工具数

20

提示词数

0

GitHub Stars

1

资源数

0
API集成JavaScript项目管理任务管理

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

作者 / 组织

maxcrystal

提供方

maxcrystal

最后核验

2026/5/17 20:20

快速接入

先看主来源和安装命令,再打开仓库或文档;下面只保留这个条目的关键接入事实。

详细介绍

Planfix MCP服务器

提供与Planfix项目管理平台无缝集成的模型上下文协议(MCP)服务器。该服务器使AI助手能够通过标准化的界面与Planfix任务进行交互。

特性

  • API健康检查:检查Planfix REST API是否可用并做出响应
  • 任务管理:在Planfix中创建、读取、更新和列出任务
  • 项目管理:在Planfix中创建、读取、更新和列出项目
  • 评论管理:在Planfix中创建、读取、更新、列出和删除任务和项目中的注释
  • 用户管理:从Planfix检索用户(员工)信息
  • 联系人管理:在Planfix中创建、读取、更新和列出联系人信息
  • 全面的现场支持:访问所有任务、项目、评论、用户和联系人字段,包括优先级、状态、日期、受让人等
  • HTTP流传输:作为HTTP服务器运行,便于集成
  • 类型安全:使用Zod模式构建,用于强大的参数验证
  • FastMCP框架:利用FastMCP库实现高效的MCP服务器实施

可用工具

ping

检查Planfix REST API是否可用,并使用/ping端点进行响应。

参数:

  • 无需

退货:

  • success (boolean):API是否响应状态代码200
  • status (string):“可用”或“不可用”
  • message (字符串):关于API状态的描述性消息
  • data (object):来自ping端点的响应数据(成功时)
  • statusCode (number):响应中的HTTP状态码
  • error (string):错误消息(失败时)
  • timestamp (string):检查的ISO时间戳

示例响应(成功):

{
  "success": true,
  "status": "available",
  "message": "Planfix REST API is available",
  "data": { /* API response data */ },
  "statusCode": 200,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

示例响应(失败):

{
  "success": false,
  "status": "unavailable",
  "message": "Planfix REST API is not available",
  "error": "Network timeout",
  "statusCode": null,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

getTask

通过可自定义的字段选择按任务ID获取任务。

参数:

  • taskId (number):任务的唯一标识符
  • fields (数组,可选):要返回的特定字段(默认为id、name、description)

可用字段: id、名称、描述、优先级、状态、processId、结果检查、类型、分配者、父级、对象、模板、项目、交易对手、dateTime、startDateTime、endDateTime、hasStartDate、hasEndDate、hasStartTime、hasEndTime、delayedTillDate、实际完成日期、上次更新日期、持续时间、持续时间单位、持续时间类型、过期、closeToDeadLine、not AcceptedInTime、收藏夹、isSummary、isSequential、受让人、参与者、审核员、重复、isDelete、文件、数据标签、sourceObjectId、sourceDataVersion

getProject

通过可自定义的字段选择按ID获取项目。

参数:

  • projectId (number):项目的唯一标识符
  • fields (数组,可选):要返回的特定字段(默认为id、name、description)

可用字段: id、名称、描述、状态、所有者、父级、模板、组、交易对手、startDate、endDate、hiddenForEmployees、hiddenForClients、过期、isCloseToDeadline、hasEndDate、受让人、参与者、审计员、客户经理、isDeleted、sourceObjectId、sourceDataVersion

getUser

通过可自定义的字段选择按ID获取用户(员工)。

参数:

  • userId (number):用户的唯一标识符
  • fields (数组,可选):要返回的特定字段(默认为id、name、email)

可用字段: id、姓名、中间名、姓氏、性别、已删除、出生日期、组、角色、登录、电子邮件、二级电子邮件、telegramId、电报、状态、电话、customFieldData、语言代码、职位、sourceObjectId、sourceDataVersion

getContact

通过自定义字段选择按ID获取联系人。

参数:

  • contactId (number | string):联系人的唯一标识符(可以是数字或“contact:123”格式)
  • fields (数组,可选):要返回的特定字段(默认为id、name、email)

可用字段: id、模板、姓名、中间名、姓氏、性别、描述、地址、站点、电子邮件、其他电子邮件地址、skype、telegramId、telegram、facebook、instagram、vk、职位、组、isCompany、isDelete、birthDate、createdDate、dateOfLastUpdate、主管、电话、公司、联系人、文件、数据标签、sourceObjectId、sourceDataVersion

getComment

通过可自定义的字段选择按ID获取评论。

参数:

  • commentId (number):评论的唯一标识符
  • fields (数组,可选):要返回的特定字段(默认为id、描述、dateTime)

可用字段: id、dateTime、类型、from类型、描述、任务、项目、联系人、所有者、已删除、已固定、隐藏、未读取、收件人、提醒、数据标签、文件、changeTaskStartDate、changeTaskExpectDate、changeStatus、sourceObjectId、sourceDataVersion

deleteComment

按ID删除注释。此操作将从Planfix中永久删除注释。

参数:

  • commentId (number):要删除的评论的唯一标识符

updateComment

更新任务中的现有注释。

参数:

  • taskId (number):包含注释的任务的唯一标识符
  • commentId (number):要更新的评论的唯一标识符
  • commentData (object):用于更新评论的数据
  • silent (布尔值,可选):是否抑制通知

addComment

在Planfix中为任务添加新注释。

参数:

  • taskId (number):要添加注释的任务的唯一标识符
  • commentData (object):用于创建评论的数据

createTask

在Planfix中创建新任务。

参数:

  • taskData (object):用于创建任务的数据

createProject

在Planfix中创建新项目。

参数:

  • projectData (object):用于创建项目的数据

createContact

在Planfix中创建新联系人或公司。

参数:

  • contactData (object):用于创建联系人的数据

listContacts

获取具有筛选和分页选项的联系人列表。

参数:

  • listParams (object):列出联系人的参数,包括分页、筛选器和要返回的字段

可用字段: id、模板、姓名、中间名、姓氏、性别、描述、地址、站点、电子邮件、其他电子邮件地址、skype、telegramId、telegram、facebook、instagram、vk、职位、组、isCompany、isDelete、birthDate、createdDate、dateOfLastUpdate、主管、电话、公司、联系人、文件、数据标签、sourceObjectId、sourceDataVersion

过滤器类型:

  • 6001:联系人姓名
  • 6002:联络小组
  • 6003:联系公司
  • 6004:联系电子邮件
  • 6005:联系电话
  • 6006:触点位置
  • 6007:联系地址
  • 其他和自定义字段标识符(6008+)

updateContact

按ID更新现有联系人。

参数:

  • contactId (number | string):联系人的唯一标识符(可以是数字或“contact:123”格式)
  • contactData (object):用于更新联系人的数据
  • silent (布尔值,可选):是否抑制通知

updateProject

按ID更新现有项目。

参数:

  • projectId (number):项目的唯一标识符
  • projectData (object):用于更新项目的数据
  • silent (布尔值,可选):是否抑制通知

updateTask

按ID更新现有任务。

参数:

  • taskId (number):任务的唯一标识符
  • taskData (object):用于更新任务的数据
  • silent (布尔值,可选):是否抑制通知

listTasks

获取具有筛选和分页选项的任务列表。

参数:

  • listParams (object):列出任务的参数,包括分页、筛选器和要返回的字段

过滤器类型:

  • 1:任务受让人
  • 5:任务项目
  • 9:任务优先级
  • 10:任务状态
  • 其他和自定义字段标识符(2-4、6-8、11+)

listProjects

获取具有筛选和分页选项的项目列表。

参数:

  • listParams (object):列出项目的参数,包括分页、筛选器和要返回的字段

可用字段: id、名称、描述、状态、所有者、父级、模板、组、交易对手、startDate、endDate、hiddenForEmployees、hiddenForClients、过期、isCloseToDeadline、hasEndDate、受让人、参与者、审计员、客户经理、isDeleted、sourceObjectId、sourceDataVersion

过滤器类型:

  • 5001:项目名称
  • 5002:项目组
  • 5003:项目对手方
  • 5004:项目业主
  • 其他和自定义字段标识符(5005+)

listComments

使用筛选和分页选项从任务中获取注释列表。

参数:

  • taskId (number):列出评论的任务的唯一标识符
  • listParams (object):列出注释的参数,包括分页、排序和要返回的字段

可用字段: id、dateTime、类型、from类型、描述、任务、项目、联系人、所有者、已删除、已固定、隐藏、未读取、收件人、提醒、数据标签、文件、changeTaskStartDate、changeTaskExpectDate、changeStatus、sourceObjectId、sourceDataVersion

类型列表选项:

  • 评论:仅限常规评论
  • 全部:所有评论类型
  • 新增:仅限新评论
  • 已删除:仅删除评论

排序字段:

  • id:评论id
  • dateTime:评论日期和时间

listUsers

获取具有过滤和分页选项的用户(员工)列表。

参数:

  • listParams (object):用于列出用户的参数,包括分页、筛选器和要返回的字段

可用字段: id、姓名、中间名、姓氏、性别、已删除、出生日期、组、角色、登录、电子邮件、二级电子邮件、telegramId、电报、状态、电话、customFieldData、语言代码、职位、sourceObjectId、sourceDataVersion

过滤器类型:

  • 9001:员工群体
  • 9002:员工电话
  • 9003:员工外部电子邮件
  • 9004:员工分机号
  • 9005:员工职位名称
  • 9006:员工姓名部分
  • 9008:员工编号
  • 9009:员工角色
  • 9120:员工出生日期
  • 9121:员工名字
  • 9122:员工中间名
  • 9123:员工姓氏
  • 9126:员工电报ID
  • 9127:员工职位id
  • 其他和自定义字段标识符(9101-9118)

其他选项:

  • onlyActive (boolean):仅检索在职员工的标志
  • prefixedId (boolean):用于检索带有前缀的id的标志(例如,'user:123')

安装

  1. 克隆存储库:
git clone https://github.com/maxcrystal/pf-mcp-server-local
cd pf-mcp-server-local
  1. 安装依赖项:
npm install
  1. 在中配置您的凭据 .env:
cp .env.example .env

编辑 .env 设置Planfix API凭据和服务器配置:

# MCP Configuration
PLANFIX_API_URL=https://your-account.planfix.ru/rest
PLANFIX_API_TOKEN=YOUR_PLANFIX_API_TOKEN
API_TIMEOUT=10000
MCP_SERVER_PORT=3030

# Optional Configuration
NODE_ENV=development
  1. 配置您的MCP客户端:
"mcp": {
  "servers": {
    "pf-mcp-server": {
      "url": "localhost:3030/mcp"
    }
  }
}

用法

启动服务器

npm start

服务器将在端口3030上启动,MCP端点位于 /mcp.

开发工具

MCP检查员

  • 使用MCP堵塞检查器: npm run jam

- 打开端口4000上的MCP检查器进行交互式调试 - 提供基于web的界面来测试MCP工具并检查服务器响应 - 用于验证工具参数和测试API集成 - 访问地址: http://localhost:4000

调试工具

  • API请求日志记录:在开发模式下自动启用
  • Zod模式验证:内置参数验证,带有详细的错误消息
  • HTTP流传输:直接HTTP端点测试 http://localhost:3030/mcp
  • 错误处理:带有状态代码和描述性消息的全面错误响应

测试API端点

您可以使用curl或任何HTTP客户端测试单个API端点:

# Test API connectivity
curl -X POST http://localhost:3030/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "ping", "params": {}}'

与AI助手集成

运行后,服务器可以连接到MCP兼容的AI助手。服务器在以下位置提供HTTP流传输:

http://localhost:3030/mcp

项目结构

src/
├── api/
│   ├── axios.js          # Axios configuration for Planfix API
│   ├── tasks/            # Task-related API functions
│   │   ├── createTask.js
│   │   ├── getTask.js
│   │   ├── listTasks.js
│   │   └── updateTask.js
│   ├── projects/         # Project-related API functions
│   │   ├── createProject.js
│   │   ├── getProject.js
│   │   ├── listProjects.js
│   │   └── updateProject.js
│   ├── comments/         # Comment-related API functions
│   │   ├── addComment.js
│   │   ├── getComment.js
│   │   ├── listComments.js
│   │   ├── updateComment.js
│   │   └── deleteComment.js
│   ├── contacts/         # Contact-related API functions
│   │   ├── createContact.js
│   │   ├── getContact.js
│   │   ├── listContacts.js
│   │   └── updateContact.js
│   └── users/            # User-related API functions
|       ├── listUsers.js
│       └── getUser.js
├── const/
│   └── schemas.js        # Zod schemas for validation
├── mcp/
│   ├── server.js         # Main MCP server setup
│   ├── tasks/            # Task-related MCP tool definitions
│   │   ├── createTask.js
│   │   ├── getTask.js
│   │   ├── listTasks.js
│   │   └── updateTask.js
│   ├── projects/         # Project-related MCP tool definitions
│   │   ├── createProject.js
│   │   ├── getProject.js
│   │   ├── listProjects.js
│   │   └── updateProject.js
│   ├── comments/         # Comment-related MCP tool definitions
│   │   ├── addComment.js
│   │   ├── getComment.js
│   │   ├── listComments.js
│   │   ├── updateComment.js
│   │   └── deleteComment.js
│   ├── contacts/         # Contact-related MCP tool definitions
│   │   ├── createContact.js
│   │   ├── getContact.js
│   │   ├── listContacts.js
│   │   └── updateContact.js
│   └── users/            # User-related MCP tool definitions
|       ├── listUsers.js
│       └── getUser.js
└── index.js              # Application entry point

依赖项

贡献

  1. 分叉存储库
  2. 创建要素分支: git checkout -b feature-name
  3. 进行更改
  4. 提交您的更改: git commit -am 'Add feature'
  5. 推到分支: git push origin feature-name
  6. 提交拉取请求

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

作者

Max水晶 - ✉️ info@maxcrystal.ru, @麦克斯晶体机器人

链接

支持

如需支持和问题,请在GitHub存储库上打开问题或直接联系作者。

目录标签

目录标签

API集成JavaScript项目管理任务管理本地部署AI助手企业协作

接入字段

传输方式(transport,传输协议)

未说明

鉴权方式(authType,认证方式)

none

工具数量(toolCount,工具数)

20

资源数量(resourceCount,资源数)

0

提示词数量(promptCount,提示词数)

0

权限和风险

未说明none部署方式未说明

接入前请确认传输方式、认证方式和部署位置,并根据实际工具能力限制访问范围。

安装前确认

不要直接授予不必要的文件、网络或账号权限;先核对安装命令和配置内容。

仍需确认:installCommand

来源信息

继续浏览同类 MCP