Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
630 changes: 401 additions & 229 deletions docs.json

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions ja/advanced/dashboard/permissions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: エディター権限
description: チームのより多くのメンバーにドキュメントの更新を許可
---

最初のドキュメントを作成したチームメンバーは、Mintlifyにサインアップした時と同じGitHubアカウントでドキュメントリポジトリにプッシュする限り、ドキュメントの更新アクセス権を持ちます。

無料プランで別のエディターがドキュメントを更新しようとすると、gitコミットチェックで警告が表示されます。

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>

gitチェック警告の詳細には、プランをアップグレードするためのリンクが記載されています。また、[ダッシュボード](https://dashboard.mintlify.com)でプランをアップグレードして、無制限のエディターがドキュメントを更新できるようにすることもできます。プランをアップグレードしたら、手動更新をトリガーするか、別の変更をプッシュして更新をデプロイしてください。

料金についての詳細は[こちら](https://mintlify.com/pricing)をご覧ください。
103 changes: 103 additions & 0 deletions ja/advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
title: シングルサインオン(SSO)
description: 管理者ダッシュボードへのチームのログイン方法をカスタマイズ
---

SAMLとOIDCを介してダッシュボードへのシングルサインオンを使用します。OktaまたはGoogle Workspaceを使用している場合、SSOの設定に関するプロバイダー固有のドキュメントがありますが、他のプロバイダーを使用している場合は、お問い合わせください!

<Note>
SSO機能はEnterpriseプランで利用可能です。[お問い合わせ](https://mintlify.com/enterprise)で詳細をご確認ください!
</Note>

## Okta

Check warning on line 12 in ja/advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ja/advanced/dashboard/sso.mdx#L12

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
の下で、`Applications`SAML 2.0を使用して新しいアプリ統合を作成するためにクリックします。
</Step>

<Step title="Configure integration">
以下を入力します:

* シングルサインオンURL(Mintlifyが提供)
* オーディエンスURI(Mintlifyが提供)
* 名前IDフォーマット:`EmailAddress`
* 属性ステートメント:
| 名前 | 名前フォーマット | 値 |
| ----------- | -------- | ---------------- |
| `firstName` | Basic | `user.firstName` |
| `lastName` | Basic | `user.lastName` |
</Step>

<Step title="Send us your IdP information">
アプリケーションの設定が完了したら、サインオンタブに移動してメタデータURLを送信してください。この情報を使用して、私たちの側で接続を有効にします。
</Step>
</Steps>
</Tab>

<Tab title="OIDC">
<Steps>
<Step title="Create an application">
下記の`Applications`をクリックして、OIDCを使用して新しいアプリ統合を作成します。
以下の`Web Application`アプリケーションタイプを選択してください。
</Step>

<Step title="Configure integration">
認証コードの付与タイプを選択し、Mintlifyから提供されたリダイレクトURIを入力してください。
</Step>

<Step title="Send us your IdP information">
アプリケーションの設定が完了したら、全般タブに移動してクライアントIDとクライアントシークレットを確認してください。
これらの情報と、OktaインスタンスURL(例:`<your-tenant-name>.okta.com`)を安全に提供してください。1PasswordやSendSafelyなどのサービスを通じて送信できます。
</Step>
</Steps>
</Tab>
</Tabs>

## Google Workspace

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
下記の`Web and mobile apps`から`Add custom SAML app`を`Add app`ドロップダウンから選択してください。

<Frame>
![](/images/gsuite-add-custom-saml-app.png)
</Frame>
</Step>

<Step title="Send us your IdP information">
提供されたSSO URL、Entity ID、x509証明書をコピーしてMintlifyチームに送信してください。

<Frame>
![](/images/gsuite-saml-metadata.png)
</Frame>
</Step>

<Step title="Configure integration">
サービスプロバイダーの詳細ページで、以下を入力してください:

* ACS URL(Mintlifyが提供)
* Entity ID(Mintlifyが提供)
* Name IDフォーマット:`EMAIL`
* Name ID:`Basic Information > Primary email`

<Frame>
![](/images/gsuite-sp-details.png)
</Frame>

次のページで、以下の属性ステートメントを入力してください:

| Googleディレクトリ属性 | アプリ属性 |
| -------------- | ----------- |
| `First name` | `firstName` |
| `Last name` | `lastName` |

このステップが完了し、ユーザーがアプリケーションに割り当てられたら、私たちのチームに連絡してください。アカウントのSSOを有効にします!
</Step>
</Steps>
</Tab>
</Tabs>
39 changes: 39 additions & 0 deletions ja/advanced/mcp/generate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: MCPジェネレーター
description: ドキュメント用のMCPサーバーのセットアップ方法を学ぶ
---

<Tip>
このページでは、独自のドキュメント用のMCPサーバーのセットアップ方法について説明します。Mintlify MCPサーバーの使用に関する情報をお探しの場合は、[Mintlify MCPサーバーのインストールと使用](/advanced/mcp/quickstart)ページをご参照ください。
</Tip>

## はじめに

実行:`npm i @mintlify/mcp`をインストールして`@mintlify/mcp`CLIを使用します。

この[ダッシュボード](https://dashboard.mintlify.com/products/mcp)で、`MCP Server`に移動して、独自のインストールコマンドを確認してください。これは`@mintlify/mcp`CLIでMCPサーバーをインストールするためのコマンドです。

<Note>
MCPサーバーが**すべての**OpenAPI仕様のエンドポイントにアクセスできるように、OpenAPIアクセスを有効にしてください。
</Note>

## MCPサーバーをローカルで起動

<Steps>
<Step title="Install the server through the CLI">
以下のコマンドを実行してサーバーをインストールします:

```bash
npx @mintlify/mcp add [your subdomain]
```
</Step>

<Step title="Add the authentication token if applicable">
APIが認証トークンを必要とする場合、エンドユーザーにトークンを取得してもらい、この応答が表示されたときに適用するように指示してください:`> What is the Authorization
(basic token)?`それ以外の場合は、このステップをスキップできます。
</Step>

<Step title="Start your MCP server">
次のコマンドを実行できます:`bash npm --prefix ~/.mcp/[your subdomain] start `
</Step>
</Steps>
97 changes: 97 additions & 0 deletions ja/advanced/mcp/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: クイックスタート
description: 製品をAIアプリに接続するためのMCPサーバーを生成
---

## はじめに

Mintlifyの MCP Generatorは、あなたの会社のドキュメントとOpenAPI仕様(利用可能な場合)に基づいてMCPサーバーを生成するCLIツールです。MCP Generatorは[npmパッケージ](https://www.npmjs.com/package/mcp)として提供されています。

MCPサーバーは、以下の主要なシナリオでMCPクライアントと共に使用できます:

1. **ドキュメントQ\&A**、AI Chatと同様です。これはドキュメントに対して自動的に有効化され、設定は必要ありません。
2. **リアルタイムAPIクエリ**、OpenAPI仕様がある場合は、`Mintlify Dashboard > Products > MCP Server`に移動してトグルを切り替え、OpenAPI仕様を有効にしてください。

<Note>
OpenAPIトグルを有効にすることで、MCPサーバーに
**すべての**OpenAPI仕様のエンドポイントへのアクセスを許可します。
</Note>

## MCPサーバーのインストール

<Tip>
このページはMintlify MCPサーバーのインストールに関するものです。独自のMCPサーバーの生成に関する情報をお探しの場合は、[MCP Generator](/advanced/mcp/generate)のページをご参照ください。
</Tip>

## Mintlify MCPサーバーでのインストール例

Mintlify MCPサーバーを使用するには[APIキー](https://mintlify.com/docs/advanced/rest-api/overview#authentication)が必要です。お持ちでない場合は、`Settings > API Keys > Chat API Key`に移動して新しいキーを作成してください。

## MCPサーバーをローカルで起動

<Steps>
<Step title="Install the server through the CLI">
以下のコマンドを実行してサーバーをインストールします:

```bash
npx @mintlify/mcp@latest add mintlify
```
</Step>

<Step title="Add the authentication token">
前のコマンドを実行すると、以下のレスポンスが表示されます:

```
> What is the Authorization (basic token)?
```

APIチャットキーを使用して、認証トークンをコピーしCLIに貼り付けてください。
</Step>

<Step title="Start your MCP server">
これで以下を実行できます:

```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
</Steps>

## Claudeでサーバーを使用

<Note>
以下をダウンロード:[Claude デスクトップアプリ](https://claude.ai/download)
</Note>

Claude デスクトップアプリをインストールしたら、以下の手順に従ってください:

<Steps>
<Step title="Navigate to the Settings > Developer" />

<Step title="Click on Edit Config">
以下を`claude_desktop_config.json`に追加してください:

```json
{
"mcpServers": {
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>

<Step title="If you see the hammer icon, you're all set!">
クリックすると、サーバーで利用可能なMCPツールが表示されます。

<Frame>
![Claude MCP](/images/mcp-with-claude.png)
</Frame>
</Step>
</Steps>
3 changes: 3 additions & 0 deletions ja/advanced/rest-api/chat/create-topic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/topic
---
3 changes: 3 additions & 0 deletions ja/advanced/rest-api/chat/generate-message.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/message
---
37 changes: 37 additions & 0 deletions ja/advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: 概要
---

## 更新のトリガー

REST APIを活用して、必要に応じてプログラムで更新をトリガーすることができます。

<Info>
主なユースケースは更新のトリガーですが、時間とともにAPIにさらに多くの機能を追加していく予定です。他に見たい機能があれば、

[コミュニティ](https://mintlify.com/community)でお知らせください!
</Info>

## 認証

APIキーは[ダッシュボード](https://dashboard.mintlify.com/settings/organization/api-keys)で生成できます。APIキーは組織全体に関連付けられており、複数のデプロイメントで使用できます。

<Frame>
<img src="/images/external-api-key.png" />
</Frame>

## 管理者APIキー

管理者APIキーはAPIの大部分で使用されます。[更新エンドポイント](/advanced/rest-api/update/trigger)を通じて更新をトリガーするために使用されます。

## チャットAPIキー

チャットAPIを使用すると、ドキュメントに基づいたAIチャット体験を任意のアプリケーションに組み込むことができ、常に最新の状態に保たれます。

レスポンスには引用が含まれているため、ユーザーが必要なヘルプを得るための適切な場所を示すことができます。

<Note>
チャットAPIトークンはフロントエンドコードで参照できる公開トークンですが、APIキーは秘密にしておく必要があるサーバーサイドトークンです。
</Note>

APIキーを取得したら、[例](https://github.com/mintlify/discovery-api-example)をチェックしてAIチャット用のAPIの使用方法を確認してください。また、この例のデプロイ版は[chat.mintlify.com](https://chat.mintlify.com)で見ることができます。
3 changes: 3 additions & 0 deletions ja/advanced/rest-api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: GET /project/update-status/{statusId}
---
3 changes: 3 additions & 0 deletions ja/advanced/rest-api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /project/update/{projectId}
---
75 changes: 75 additions & 0 deletions ja/advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Cloudflare
description: Cloudflare Workersを使用して/docsサブパスでドキュメントをホストする
---

## Cloudflare Workerを作成する

移動して`Workers & Pages > Create application > Create worker`。新しいCloudflare workerを作成できる以下の画面が表示されるはずです。

<Frame>
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
</Frame>

<Warning>
注意:DNSプロバイダーがCloudflareの場合、CNAMEレコードのプロキシを使用しないでください
</Warning>

### カスタムドメインを追加

workerが作成されたら、クリックして`Configure worker`。workerに移動して
`Settings > Triggers`。クリックして`Add Custom Domain`希望のドメインをリストに追加します - `www.`
を付けたバージョンと付けないバージョンの両方を追加することをお勧めします。

<Frame>
<img alt="Cloudflare worker custom domain" src="/images/cloudflare/custom-domain.png" />
</Frame>

カスタムサブディレクトリの設定に問題がある場合、
[サポートチームにお問い合わせください](mailto:[email protected])。ホスティングのアップグレードについてご案内いたします。

### Workerスクリプトを編集

クリックして`Edit Code`以下のスクリプトをworkerのコードに追加します。

<Frame>
<img alt="Cloudflare edit code" src="/images/cloudflare/edit-code.png" />
</Frame>

<Tip>
編集`DOCS_URL`を`[SUBDOMAIN]`あなたの固有のサブドメインに置き換えて`CUSTOM_URL`をあなたのウェブサイトのベースURLに置き換えてください。
</Tip>

```javascript
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// If the request is to the docs subdirectory
if (/^\/docs/.test(urlObject.pathname)) {
// Then Proxy to Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";

let url = new URL(request.url);
url.hostname = DOCS_URL;

let proxyRequest = new Request(url, request);

proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");

return await fetch(proxyRequest);
}
} catch (error) {
// if no action found, play the regular request
return await fetch(request);
}
}
```

クリックして`Deploy`変更が反映されるまで待ちます(最大で数時間かかる場合があります)。
Loading