使用说明
Binelek平台VS代码扩展
Binelek平台的官方VS代码扩展。提供集成开发工具,用于使用Binelek知识图、本体和AI服务。
✨ 也适用于Cursor! Cursor基于VS Code构建,并支持所有VS Code扩展。
特性
- 本体浏览器 -在VS Code侧栏中浏览和探索您的知识图实体
- Cypher查询运行器 -直接从VS代码执行Cypher查询
- 语义搜索 -使用自然语言搜索实体
- 实体管理 -创建、更新和查看实体详细信息
- YAML验证 -根据Binelek模式验证本体YAML文件
- 代码生成 -从本体YAML(C#、TypeScript、Python、Cypher)生成代码
- AI聊天 -与Binelek AI助手聊天
- 管道管理 -查看和触发数据管道
安装
先决条件
-
Binelek平台 必须正在运行:
docker-compose up -d # Start Binelek services -
Binelek MCP服务器 必须安装:
cd /path/to/binelek-mcp-server npm install npm run build
安装扩展
来自VSIX(推荐)
# Package the extension
cd /path/to/binelek-vscode-extension
npm install
npm run compile
npm run package
# Install in VS Code
code --install-extension binelek-platform-1.0.0.vsix
# Install in Cursor (same command works!)
code --install-extension binelek-platform-1.0.0.vsix
注: 该扩展在VS Code和Cursor中的工作方式相同,因为Cursor是在VS Code之上构建的。
来源(发展)
- 在VS Code中打开此目录
- 按
F5启动扩展开发主机 - 扩展程序将在新窗口中处于活动状态
配置
打开VS代码设置并配置:
{
"binelek.gatewayUrl": "http://localhost:8092",
"binelek.tenantId": "core",
"binelek.mcpServerPath": "node /path/to/binelek-mcp-server/build/index.js",
"binelek.autoConnect": true
}
配置选项
| 设置 | 说明 | 默认值 |
|---|---|---|
binelek.gatewayUrl |
Binelek API网关URL | http://localhost:8092 |
binelek.tenantId |
默认租户ID | core |
binelek.mcpServerPath |
MCP服务器的路径 | (必需) |
binelek.autoConnect |
启动时自动连接 | true |
用法
1.身份验证
- 打开命令选项板(
Cmd+Shift+P/Ctrl+Shift+P) - 跑 “Binelek:身份验证”
- 输入您的电子邮件和密码
- ✓ 有联系的!
2.探索本体论
- 打开 Binelek本体论 在资源管理器侧栏中查看
- 浏览实体类型
- 点击实体查看详细信息
- 点击刷新图标重新加载
3.运行密码查询
命令: Binelek: Run Cypher Query (Cmd+Shift+C)
MATCH (p:Property)
WHERE p.price > 500000
RETURN p
LIMIT 10
结果显示在“输出”面板中。
4.搜索实体
语义搜索 (Cmd+Shift+S):
luxury waterfront properties with modern amenities
关键字搜索:
residential property
5.创建实体
命令: Binelek: Create Entity
- 输入实体类型:
Property - 以JSON格式输入属性:
{ "address": "123 Main St", "price": 500000, "sqft": 2500 }
6.验证并生成代码
打开一个本体YAML文件,然后:
- 验证:
Binelek: Validate Ontology YAML - 生成:
Binelek: Generate Code from YAML- 选择目标语言(C#、TypeScript、Python、Cypher)
- 生成的代码在新编辑器中打开
7.人工智能聊天
命令: Binelek: Chat with AI
询问有关数据的问题:
- “最贵的房产是什么?”
- “显示带有太阳能电池板的房产”
- “分析旧金山的房地产趋势”
命令参考
| 命令 | 键绑定 | 说明 |
|---|---|---|
Binelek: Authenticate |
- | 登录Binelek平台 |
Binelek: Disconnect |
- | 退出 |
Binelek: Refresh Ontology Explorer |
- | 重新加载本体树 |
Binelek: Run Cypher Query |
Cmd+Shift+C |
执行Cypher查询 |
Binelek: Semantic Search |
Cmd+Shift+S |
使用自然语言搜索 |
Binelek: Keyword Search |
- | 使用关键字搜索 |
Binelek: Create Entity |
- | 创建新实体 |
Binelek: Validate Ontology YAML |
- | 验证YAML文件 |
Binelek: Generate Code from YAML |
- | 生成代码 |
Binelek: List Data Pipelines |
- | 显示所有管道 |
Binelek: Chat with AI |
- | 与AI助手聊天 |
建筑
VS Code Extension
↓ stdio
MCP Server (binelek-mcp-server)
↓ HTTP/REST
API Gateway (localhost:8092)
↓ routes to
Backend Services (Ontology, Search, AI, etc.)
该扩展通过以下方式与后端服务通信:
- MCP服务器 -通过stdio提供基于工具的界面
- API网关 -处理身份验证、租户隔离、速率限制
发展
# Install dependencies
npm install
# Compile TypeScript
npm run compile
# Watch mode (auto-compile)
npm run watch
# Run tests
npm test
# Package extension
npm run package
故障排除
“未连接到Binelek”
- 检查API网关是否正在运行:
curl http://localhost:8092/health - 检查设置中的MCP服务器路径
- 再次尝试身份验证
“MCP连接失败”
- 验证MCP服务器是否已构建:
cd binelek-mcp-server && npm run build - 检查服务器路径格式:
node /full/path/to/build/index.js - 检查输出面板中的日志(选择“Binelek”频道)
“身份验证失败”
- 验证凭据
- 检查API网关日志:
docker-compose logs binah-api - 尝试直接访问网关:
curl http://localhost:8092/api/auth/login
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 彻底测试
- 提交拉取请求
许可证
麻省理工学院
支持
- 文档: https://docs.binelek.com
- 问题: https://github.com/k5tuck/binelek-vscode-extension/issues
- 电子邮件: support@binelek.com
