短链接管理服务

一个基于MCP协议的短链接管理服务,支持创建、更新、删除和管理短链接。

  • by sdotee
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 sdotee/url-shorten-mcp-server

使用说明

请参阅URL缩短器MCP服务器

注意:此存储库不再维护。请参阅 官方MCP服务器实现 获取最新版本。

See URL缩短服务(s.ee)的模型上下文协议(MCP)服务器。该服务器使AI助手能够通过MCP协议创建、更新、删除和管理短网址。

🚀 特性

  • 创建短网址:使用可选的自定义slug生成缩短的网址
  • 更新URL:修改现有的短URL及其元数据
  • 删除网址:从服务中删除短网址
  • 列出域名:查看可用域名以缩短URL
  • Docker支持:使用Docker和Docker Compose轻松部署
  • 环境配置:通过环境变量灵活配置

📋 先决条件

  • Node.js(v18或更高版本)
  • pnpm包管理器
  • Docker和Docker Compose(用于容器化部署)
  • 请参阅URL缩短器API密钥(来自 s.ee)

🛠️ 安装

选项1:地方发展设置

  1. 克隆存储库

    git clone https://github.com/your-username/shorten-url-mcp-server.git
    cd shorten-url-mcp-server
    
  2. 安装依赖项

    pnpm install
    
  3. 配置环境变量

    创建一个 .env 根目录中的文件:

    # Server configuration
    BIND_PORT=3000
    BIND_HOST=0.0.0.0
    
    # See URL shortener API configuration
    URL_SHORTENER_API_KEY=your_api_key_here
    URL_SHORTENER_API_BASE=https://s.ee
    URL_SHORTENER_DEFAULT_DOMAIN=s.ee
    
  4. 启动服务器

    pnpm serve
    

选项2:Docker部署

  1. 克隆存储库

    git clone https://github.com/your-username/shorten-url-mcp-server.git
    cd shorten-url-mcp-server
    
  2. 配置环境变量

    编辑 compose.yaml 归档并更新环境变量:

    environment:
      BIND_PORT: "3000"
      BIND_HOST: "0.0.0.0"
      URL_SHORTENER_API_KEY: "your_api_key_here"
      URL_SHORTENER_API_BASE: "https://s.ee"
      URL_SHORTENER_DEFAULT_DOMAIN: "s.ee"
    
  3. 从Docker Compose开始

    docker-compose up -d
    
  4. 查看日志

    docker-compose logs -f
    

🔧 配置

环境变量

变量 描述 默认值
BIND_PORT MCP服务器的端口 3000
BIND_HOST MCP服务器的主机 0.0.0.0
URL_SHORTENER_API_KEY s.ee服务的API密钥 必需
URL_SHORTENER_API_BASE s.ee API的基本URL https://s.ee
URL_SHORTENER_DEFAULT_DOMAIN 缩短URL的默认域 s.ee

🔨 可用工具

MCP服务器提供以下工具:

1. create_link

在.ee上创建新的短链接。

参数:

  • target_url (字符串,必填):要缩短的目标URL
  • domain (string,必填):用于短链接的域
  • slug (string,可选):短链接的自定义slug
  • title (字符串,可选):链接的标题

例子:

{
  "target_url": "https://example.com/very-long-url",
  "domain": "s.ee",
  "slug": "my-custom-slug",
  "title": "My Example Link"
}

2. update_link

更新现有的短链接。

参数:

  • slug (string,必填):要更新的链接的slug
  • target_url (字符串,必填):新的目标URL
  • domain (string,必填):链接的域
  • title (字符串,可选):链接的新标题

3. delete_link

删除现有的短链接。

参数:

  • slug (string,必填):要删除的链接的slug
  • domain (string,必填):链接的域

4. list_domains

列出所有可用于缩短链接的域。

参数:无

🚀 用法示例

服务器在以下位置公开HTTP端点 /mcp 其接受MCP协议请求:

curl -X POST http://localhost:3000/mcp \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "create_link",
      "arguments": {
        "target_url": "https://example.com",
        "domain": "s.ee"
      }
    }
  }'

🛡️ 安全考虑

  • API密钥保护:永远不要将API密钥提交给版本控制
  • 环境变量:使用环境变量进行敏感配置
  • 网络安全:考虑在生产环境中使用HTTPS
  • 速率限制:注意s.ee服务的API速率限制

📝 API 参考

MCP协议端点

  • POST /mcp -处理MCP请求
  • GET /mcp -处理SSE流(用于会话管理)
  • DELETE /mcp -处理会话终止

请参阅URL缩短器API

此服务器与See URL shortener API接口。有关API的更多信息,请访问 s.ee.

📄 许可证

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

🆘 支持

如果您遇到任何问题:

  1. 检查 GitHub问题
  2. 查看服务器日志中的错误消息
  3. 请确保您的API密钥有效并且具有必要的权限
  4. 验证是否可以从您的网络访问.ee服务

📚 资源