使用说明
欢迎来到@cap-js/mcp服务器
[!注意] 该项目处于alpha状态。
关于本项目
模型上下文协议(MCP)服务器 SAP云应用程序编程模型(CAP). 将其用于人工智能辅助开发CAP应用程序(能动性编码).
服务器帮助AI模型回答以下问题:
- 这个项目中有哪些CDS服务,在哪里提供服务?
- 这些实体是关于什么的,它们之间是如何联系的?
- 如何在CAP Node.js中向select语句添加列?
目录
需求
看 入门指南 关于如何在使用SAP云应用程序编程模型的过程中快速启动开发和成长。
设置
npm i -g @cap-js/mcp-server
这将提供命令 cds-mcp 启动CAP MCP服务器。
配置您的MCP客户端(Cline、opencode、Claude Code、GitHub Copilot等)以使用 cds-mcp 命令。
VS代码中的用法
VS代码扩展示例 克莱恩:
{
"mcpServers": {
"cds-mcp": {
"command": "cds-mcp",
"args": [],
"env": {}
}
}
}
看 VS代码市场 更多代理扩展。
在opencode中的使用
示例 开源代码:
{
"mcp": {
"cds-mcp": {
"type": "local",
"command": ["cds-mcp"],
"enabled": true
}
}
}
规则
以下规则有助于LLM正确使用服务器:
- You MUST search for CDS definitions, like entities, fields and services (which include HTTP endpoints) with cds-mcp, only if it fails you MAY read \*.cds files in the project.
- You MUST search for CAP docs with cds-mcp EVERY TIME you create, modify CDS models or when using APIs or the `cds` CLI from CAP. Do NOT propose, suggest or make any changes without first checking it.
将这些规则添加到现有的全局或项目特定规则中 AGENTS.md (具体细节可能因MCP客户端而异)。
CLI使用情况
出于实验目的,您还可以直接从命令行使用这些工具:
# Search for CDS model definitions
cds-mcp search_model . Books entity
# Search CAP documentation
cds-mcp search_docs "how to add columns to a select statement in CAP Node.js" 1
可用工具
[!注意] 人工智能模型使用的工具并不构成一个稳定的API。
服务器为CAP开发提供了以下工具:
search_model
此工具对编译的CDS模型(核心模式表示法)中的定义名称进行模糊搜索。
CDS编译您的所有 .cds 将文件转换为统一的模型表示,其中包括:
- 所有定义及其关系
- 注释
- HTTP端点
模糊搜索算法匹配定义名称并允许部分匹配,即使在搜索“图书”时,也很容易找到像“图书”这样的实体。
search_docs
该工具使用向量嵌入在本地搜索作为嵌入存储的预处理CAP文档。该过程如下:
- 查询处理: 您的搜索查询将转换为嵌入向量。
- 相似性搜索: 系统会找到与您的查询具有最高语义相似性的文档块。
这种语义搜索方法使您能够找到相关文档,即使您的查询没有使用文档中找到的确切关键字,所有这些都是在您的机器上本地找到的。
支持、反馈、贡献
该项目对功能请求/建议、错误报告等开放,通过 GitHub问题。我们鼓励并始终欢迎您的贡献和反馈。有关如何贡献、项目结构以及其他贡献信息的更多信息,请参阅我们的 贡献指南.
安全/披露
如果您发现任何可能是安全问题的错误,请按照我们的说明进行操作 在我们的安全政策中 关于如何报告。请不要因安全相关的疑虑或问题而创建GitHub问题。
行为准则
作为成员、贡献者和领导者,我们承诺让每个人都能在社区中获得无骚扰的体验。参与此项目即表示您同意遵守其 行为准则 在任何时候。
许可
版权所有2025 SAP SE或SAP附属公司和@cap-js/cds-mcp贡献者。请查看我们的 许可证 版权和许可信息。包括第三方组件及其许可/版权信息在内的详细信息可用 通过REUSE工具.
致谢
- onnxruntime网站 用于在本地创建嵌入。
- @huggingface/transformers.js 用于比较WordPiece标记器的输出。
- @模型上下文协议/sdk 为MCP提供SDK。
