# @ama-sdk/mcp 中文文档

规范地址：https://npmcn.com/package/%40ama-sdk/mcp/

版本：15\.3\.1
npm 元数据更新时间：2026-11-10T11:04:25.036Z
中文译文更新时间：2026-11-10T12:13:42.167Z
软件包许可：BSD-3-Clause

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ama-sdk/mcp
原文对照：https://npmcn.com/package/%40ama-sdk/mcp/?lang=original
项目主页：https://amadeusitgroup.github.io/otter/
源码仓库：https://github.com/AmadeusITGroup/otter

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：40.9 kB，20 个文件
- TypeScript 类型：未声明
- Node.js 要求：^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0
- 运行依赖：6 个
- 首次发布：2026-05-14T00:26:29.154Z
- 最新版本发布：2026-11-10T11:04:24.670Z
- 近 30 天下载量：3338（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：234（近 12 个月 234 个）

## 中文简介

实验包 -- MCP模块,从安装的包到AI助手的SDK CONTEXT.md

## 安装

```sh
npm install @ama-sdk/mcp
```

也可以使用：`pnpm add @ama-sdk/mcp`、`yarn add @ama-sdk/mcp`、`bun add @ama-sdk/mcp`

## README

# @ ama- sdk/ mcp

用于曝光的 MCP 模块 `SDK_CONTEXT.md` 从已安装的软件包到AI助手.

## 目的

当使用 SDK 生成时 [@ama-sdk/形状](https://www.npmjs.com/package/@ama-sdk/schematics),它们可以包括 `SDK_CONTEXT.md` 文件描述 :

-   可用的 API 域和操作
-   每个域所用的模型
-   避免幻觉的人工智能工具准则

这个MCP模块使用Node.js的模块分辨率自动从已安装的包中发现并加载了这些上下文文件,然后将其暴露给AI助手.

## 配置

### VS 代码 `.vscode/mcp.json`

在您直接配置 SDK 包 `.vscode/mcp.json`数字 :

```json
{
  "servers": {
    "sdk-context": {
      "command": "npx",
      "args": ["-y", "-p", "@ama-sdk/mcp", "ama-sdk-mcp", "--packages", "@my-scope/my-sdk-package", "@other-scope/other-sdk"]
    }
  }
}
```

## 使用量

### CLI(用于mcp.json) 互联网档案馆的存檔,存档日期2013-12-02

```bash
# Specify packages with --packages flag
ama-sdk-mcp --packages @my-scope/my-sdk @other-scope/other-sdk

# Show help
ama-sdk-mcp --help
```

### 程序化( 自定义 MCP 服务器)

```typescript
import { registerSdkContextToolAndResources } from '@ama-sdk/mcp';

// With explicit packages
await registerSdkContextToolAndResources(server, {
  sdkPackages: ['@my-scope/my-sdk']
});

// Or reads from package.json sdkContext.packages automatically
await registerSdkContextToolAndResources(server);
```

### 可用工具

**`get_sdk_context`** - 为已配置的软件包检索 SDK 上下文

```
// List all configured SDKs with context
get_sdk_context()

// Get context for specific package
get_sdk_context({ packageName: "@my-scope/my-sdk-package" })
```

### 可用资源

**`sdk-context://instructions`** - 人工智能助理的使用指南

该资源提供如何有效使用SDK上下文的指令,以便在执行特性时避免幻觉. AI 助手在使用前应先读取此资源 `get_sdk_context` 工具.

**`sdk-context://<package-name>`** - 每个配置软件包的 SDK 上下文

每个配置的 SDK 软件包有一个 `SDK_CONTEXT.md` 文件作为资源被曝光.

## 如何运作

1.  读取 `sdkContext.packages` 从项目 `package.json` 或使用 CLI 参数
2.  用途节点.js `require.resolve()` 自动定位软件包
3.  装入 `SDK_CONTEXT.md` 从每个已解析的软件包中
4.  每个都登记为 MCP 资源
5.  为 AI 助手提供查询 SDK 信息的工具

## 软件包分辨率

SDK 使用 Node.js 自动发现软件包 `require.resolve()`这意味着:

-   **不需要手动路径配置** - 自动找到软件包
-   **工作空间** - 支持 npm/yarn/pnpm 工作空间配置
-   **弹性安装** - 与本地、全球或定制模块路径合作
-   **处理错误** - 找不到软件包时清除出错信息

如果找不到软件包,请确保:

1.  软件包已安装( Name`npm install <package-name>`(中文(简体) )
2.  包名拼写正确
3.  包有一个 `SDK_CONTEXT.md` 文件在其根中

**警卫**:系统验证了软件包名称,以防止路径倒转攻击,只接受有效的npm软件包名称模式.

## 解决问题

### 未找到软件包

```
Package "@my-scope/my-sdk" not found. Is it installed?
```

**解决方案**: 在配置中安装软件包或验证名称.

### 找不到 SDK CONTEXT. md

```
No SDK_CONTEXT.md found for @my-scope/my-sdk
```

**解决方案**: 使用以下命令生成上下文文件.

## 生成 SDK 背景

SDK 维护者可以生成 `SDK_CONTEXT.md` 使用:

```bash
cd /path/to/sdk-project
npx amasdk-update-sdk-context --interactive
```

## 常见问题

### @ama-sdk/mcp 是什么？

实验包 -- MCP模块,从安装的包到AI助手的SDK CONTEXT\.md

### 如何安装 @ama-sdk/mcp？

在项目目录运行 npm install @ama-sdk/mcp，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ama-sdk-mcp、ama-sdk-mcp-start，可以用 npx ama-sdk-mcp 直接运行。

### @ama-sdk/mcp 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ama-sdk\_\_mcp 是否存在。

### @ama-sdk/mcp 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ama-sdk/mcp 可以商用吗？

@ama-sdk/mcp 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @ama-sdk/mcp 的下载量有多少？

根据 npm 官方下载统计，@ama-sdk/mcp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,338 次，日均约 111 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ama-sdk/mcp 还在维护吗？

最新版本 15\.3\.1 发布于 2026/11/10（今天）；至今共发布 234 个版本，其中过去 12 个月发布了 234 个；首次发布于 2026/05/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。