PP

popstas/planfix-mcp-server

API development

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기

11 stars 9 forks 품질 62 트렌드 22

This MCP server provides integration with the Planfix API, allowing Model Context Protocol (MCP) clients to interact with Planfix CRM and task management system.

개요

This MCP server provides integration with the Planfix API, allowing Model Context Protocol (MCP) clients to interact with Planfix CRM and task management system. - Lead management (create, search, convert to tasks) - Lead searches can reuse a known clientId to skip contact lookups - Contact and company management - Task management (create, search, comment) - Report generation and management - Uses Planfix REST API v2.0 (API docs) - Authentication via Bearer token The server requires the following environment variables for Planfix API access: - PLANFIX_ACCOUNT – Your Planfix account name (e.g., yourcompany) - PLANFIX_TOKEN – Planfix API token with necessary permissions - PLANFIX_BASE_URL – (optional) Override the REST API base URL. Defaults to https:// .planfix.com/rest/. Set this for .ru and other regional installations, e.g. https://yourcompany.planfix.ru/rest/ - PLANFIX_ACCOUNT_URL – (optional) Override the web origin used for human-facing links (task/contact/user pages).

README

원문 README의 일부입니다. 원문 보기.

Planfix MCP Server

This MCP server provides integration with the Planfix API, allowing Model Context Protocol (MCP) clients to interact with Planfix CRM and task management system.

Features

  • Lead management (create, search, convert to tasks)
  • Lead searches can reuse a known clientId to skip contact lookups
  • Contact and company management
  • Task management (create, search, comment)
  • Report generation and management
  • Uses Planfix REST API v2.0 (API docs)
  • Authentication via Bearer token

Configuration

The server requires the following environment variables for Planfix API access:

  • PLANFIX_ACCOUNT – Your Planfix account name (e.g., yourcompany)
  • PLANFIX_TOKEN – Planfix API token with necessary permissions
  • PLANFIX_BASE_URL – (optional) Override the REST API base URL. Defaults to https://.planfix.com/rest/. Set this for .ru and other regional installations, e.g. https://yourcompany.planfix.ru/rest/
  • PLANFIX_ACCOUNT_URL – (optional) Override the web origin used for human-facing links (task/contact/user pages). Defaults to PLANFIX_BASE_URL without the trailing /rest/
  • PLANFIX_FIELD_ID_EMAIL – Custom field ID for email
  • PLANFIX_FIELD_ID_EMAIL_ADDITIONAL – (optional, no default) Numeric custom field ID used to store additional email addresses (multi-value). Must point at a real multi-value custom field you created on your account; the system secondary-email field id 124 is not a valid write target. When unset, storing additional addresses is disabled (matching by the system field still works). The Planfix system secondary-email field (additionalEmailAddresses) is read-only over the REST API, so additional addresses are written to this custom field; matching uses both the system field (filter type 4221) and this custom field (filter type 4101), for any email search once this is set
  • PLANFIX_FIELD_ID_PHONE – Custom field ID for phone
  • PLANFIX_FIELD_ID_TELEGRAM – Set any value to use the system Telegram field
  • PLANFIX_FIELD_ID_TELEGRAM_CUSTOM – Custom field ID for Telegram when using the custom field
  • PLANFIX_FIELD_ID_CLIENT – Custom field ID for client
  • PLANFIX_FIELD_ID_MANAGER – Custom field ID for manager
  • PLANFIX_FIELD_ID_AGENCY – Custom field ID for agency
  • PLANFIX_FIELD_ID_LEAD_SOURCE – Custom field ID for lead source
  • PLANFIX_FIELD_ID_LEAD_SOURCE_VALUE – Value ID for default lead source
  • PLANFIX_FIELD_ID_PIPELINE – Custom field ID for pipeline
  • PLANFIX_FIELD_ID_TAGS – Custom field ID for task tags
    • Missing tag names will be added automatically to the directory
  • PLANFIX_FIELD_ID_LEAD_ID – Custom field ID for external lead ID
  • PLANFIX_LEAD_TEMPLATE_ID – ID of the lead task template
GitHub에서 전체 README 보기

설치

npx -y @popstas/planfix-mcp-server
MCP 초보자라면? mcpskill.org 가이드부터 시작하세요 →

설정

{ "mcpServers": { "planfix": { "command": "npx", "args": [ "-y", "@popstas/planfix-mcp-server" ], "env": { "PLANFIX_ACCOUNT": "yourcompany", "PLANFIX_TOKEN": "your-api-token", "PLANFIX_FIELD_ID_EMAIL": "123", "PLANFIX_FIELD_ID_PHONE": "124", "PLANFIX_FIELD_ID_TELEGRAM": "1", "PLANFIX_FIELD_ID_TELEGRAM_CUSTOM": "125", "PLANFIX_FIELD_ID_CLIENT": "126", "PLANFIX_FIELD_ID_MANAGER": "127", "PLANFIX_FIELD_ID_AGENCY": "128", "PLANFIX_FIELD_ID_TAGS": "129", "PLANFIX_FIELD_ID_LEAD_ID": "130", "PLANFIX_LEAD_TEMPLATE_ID": "42", "PLANFIX_TASK_TITLE_TEMPLATE": "{name} - работа с клиентом" } } } }