Inky MCP Server

Inky MCP服务器

](https://www.npmjs.com/package/inky-mcp-server) ](https://www.npmjs.com/package/inky-mcp-server)

Inky的MCP（模型上下文协议）服务器，提供对存储在Pinecone中的个性化编码规则的访问。该服务器充当CursorIDE和Inky后端API之间的桥梁。

📦 发布于npmjs：

概述

Inky MCP服务器允许您直接从Cursor IDE访问个性化软件规则。它连接到您托管的Inky API端点，并从Pinecone数据库中检索规则。

特性

• ✅ 列出所有编码规则
• ✅ 按存储库筛选规则
• ✅ 安全的API密钥身份验证
• ✅ JSON-RPC 2.0协议合规性
• ✅ 与Cursor IDE兼容

安装

该软件包在npmjs上可用： inky mcp服务器

使用npx（推荐）

npx -y inky-mcp-server

使用npm

npm install -g inky-mcp-server

使用pnpm

pnpm add -g inky-mcp-server

使用纱线

yarn global add inky-mcp-server

配置

1.获取您的API代币

首先，您需要从Inky帐户生成MCP访问令牌。令牌将采用以下格式 inky_....

2.配置游标IDE

将以下配置添加到光标设置中。配置文件的位置取决于您的操作系统：

macOS/Linux： ~/.cursor/mcp.json\ 窗户： %APPDATA%\Cursor\mcp.json

选项1:HTTP传输（推荐-直接API访问）

{
  "mcpServers": {
    "inky": {
      "url": "https://your-domain.com/api/mcp",
      "headers": {
        "Authorization": "Bearer inky_YOUR_TOKEN_HERE"
      }
    }
  }
}

选项2：标准传输（使用MCP服务器包）

{
  "mcpServers": {
    "inky": {
      "command": "npx",
      "args": ["-y", "inky-mcp-server"],
      "env": {
        "API_KEY": "inky_YOUR_TOKEN_HERE",
        "INKY_API_URL": "https://your-domain.com"
      }
    }
  }
}

环境变量

• API_KEY （必填）：您的Inky MCP访问令牌（以开头 inky_)
• INKY_API_URL （可选）：您的Inky API基础URL。默认值为：

- NEXT_PUBLIC_APP_URL 环境变量 - http://localhost:3000 如果未设置

用法

配置后，MCP服务器将在Cursor IDE中可用。您可以使用它来：

列出所有规则

查询所有编码规则：

List all my coding rules

按存储库筛选

获取特定存储库的规则：

Show me rules for repository [repository_id]

API 参考

MCP服务器使用JSON-RPC 2.0协议与Inky后端API通信。

工具

list_rules

列出所有用户的规则，可选择按存储库筛选。

参数：

• repository_id （可选）：按存储库ID筛选规则

请求示例：

{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "list_rules",
    "arguments": {
      "repository_id": "repo_123"
    }
  },
  "id": 1
}

示例响应：

{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "[{\"id\":\"rule_123\",\"name\":\"TypeScript Best Practices\",\"content\":\"...\",\"version\":1,\"is_active\":true,\"repository_id\":\"repo_123\",\"created_at\":\"2024-01-01T00:00:00Z\"}]"
      }
    ]
  },
  "id": 1
}

发展

从源头构建

cd packages/mcp-server
pnpm install
pnpm build

以开发模式运行

pnpm dev

测试

您可以使用主存储库中包含的Postman集合测试MCP服务器(postman-mcp-collection.json).

建筑

┌─────────────┐
│  Cursor IDE │
└──────┬──────┘
       │ stdio
       │
┌──────▼──────────────────┐
│  Inky MCP Server         │
│  (This Package)          │
└──────┬──────────────────┘
       │ HTTP POST
       │ Bearer Token
       │
┌──────▼──────────────────┐
│  Inky Backend API        │
│  /api/mcp                │
└──────┬──────────────────┘
       │
┌──────▼──────────────────┐
│  Pinecone Database       │
│  (User's Rules)          │
└──────────────────────────┘

安全

• API令牌通过环境变量传递（从不硬编码）
• 所有API请求都使用承载令牌身份验证
• 令牌被散列并安全地存储在数据库中
• 每个用户只能访问自己的规则

故障排除

服务器未启动

错误： Error: API_KEY environment variable is required

解决方案： 确保您已设置 API_KEY Cursor MCP配置中的环境变量。

连接错误

错误： Backend API error

解决方案：

1. 验证您的 INKY_API_URL 是正确的
2. 检查您的API令牌是否有效
3. 确保后端API可访问

未返回任何规则

解决方案：

1. 验证您在Inky帐户中创建了规则
2. 检查您的API令牌是否属于正确的用户
3. 尝试先列出不带存储库筛选器的规则

许可证

麻省理工学院

支持

有关问题和疑问，请参阅Inky主存储库。