使用说明
项目简介
Port MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它允许大型语言模型(LLM)客户端通过标准化的 MCP 协议与 Port.io 平台进行交互。该服务器主要提供了一个工具,使 LLM 能够调用 Port.io 的 AI Agent,从而扩展 LLM 的能力,使其可以利用 Port.io 提供的智能服务。
主要功能点
- 工具 (Tools) 注册与执行: 提供 'trigger_port_agent' 工具,允许 LLM 客户端通过发送 prompt 来触发 Port.io 的 AI Agent 并获取其响应。
- 与 Port.io API 集成: 作为 Port.io 平台的桥梁,使得 LLM 可以安全地调用 Port.io 的 AI Agent 功能。
- 标准 MCP 服务器: 遵循 MCP 协议规范,易于与任何兼容 MCP 协议的 LLM 客户端集成。
- 灵活的部署方式: 支持通过命令行启动,并可通过环境变量或命令行参数配置 Port.io API 的凭据。
安装步骤
- 安装 Python 虚拟环境 (推荐):
python -m venv .venv - 激活虚拟环境:
- 在 Unix/macOS 系统中:
source .venv/bin/activate - 在 Windows 系统中:
.venv\Scripts\activate
- 在 Unix/macOS 系统中:
- 安装项目依赖:
pip install -e .
服务器配置
MCP 服务器需要配置在 MCP 客户端中,以便客户端能够连接并使用服务器提供的功能。以下是在 'claude_desktop_config.json' 和 Cursor 中配置 Port MCP Server 的示例。
Claude Desktop 配置示例 ( 'claude_desktop_config.json' ):
{ "mcpServers": { "port": { "command": "uvx", "args": [ "mcp-server-port", "--client-id", "<你的 Port.io Client ID>", // 替换为你的 Port.io Client ID "--client-secret", "<你的 Port.io Client Secret>", // 替换为你的 Port.io Client Secret "--region", "<API 区域>" // 替换为你的 Port.io API 区域,例如 "US" 或 "EU" ] } } }
Cursor 配置示例 (MCP Servers 设置):
-
Name: 'Port' (服务器名称,自定义)
-
Type: 'Command' (服务器类型为命令行命令)
-
Command: '/path/to/your/file/run-port-mcp.sh' (指向运行服务器的脚本的路径。你需要创建 'run-port-mcp.sh' 脚本并替换为你的脚本路径,脚本内容参考README.md)
'run-port-mcp.sh' 脚本示例 (请根据实际 'uvx' 安装路径和脚本存放路径进行调整):
#!/bin/bash # 假设 uvx 安装在 ~/.local/bin/uvx,脚本放在 /path/to/your/file/run-port-mcp.sh cd ~/.local/bin/uvx # 运行服务器,替换 <你的 Port.io Client ID>, <你的 Port.io Client Secret>, <API 区域> 为实际值 ./.venv/bin/uvx [email protected] --client-id <你的 Port.io Client ID> --client-secret <你的 Port.io Client Secret> --region <API 区域>请确保 'run-port-mcp.sh' 脚本具有执行权限 ('chmod +x /path/to/your/file/run-port-mcp.sh')。
注意:
- '<你的 Port.io Client ID>' 和 '<你的 Port.io Client Secret>' 需要替换为你 Port.io 账户的 API 凭据。
- '<API 区域>' 需要替换为你的 Port.io API 区域,通常为 "US" 或 "EU"。
- 'command' 和 'args' 指示了 MCP 客户端如何启动和配置 Port MCP Server。客户端会使用这些信息在需要时自动启动服务器。
基本使用方法
配置完成后,在兼容 MCP 协议的 LLM 客户端中(如 Claude 或 Cursor),你就可以使用 'trigger_port_agent' 工具了。
例如,在 Claude 中,你可以通过自然语言指令来调用该工具,例如:
'@port trigger_port_agent prompt: 请帮我总结一下最近的AI行业新闻'
客户端会将 '@port trigger_port_agent' 识别为对 Port MCP Server 中 'trigger_port_agent' 工具的调用,并将 'prompt: 请帮我总结一下最近的AI行业新闻' 作为参数传递给服务器。服务器会调用 Port.io 的 AI Agent 并将结果返回给客户端。
信息
分类
AI与计算