Skip to content

Commit d6a210d

Browse files
mintlify[bot]mintlify[bot]
authored
Documentation edits made through Mintlify web editor
1 parent e1cdf6a commit d6a210d

File tree

107 files changed

+9257
-229
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+9257
-229
lines changed

‎docs.json‎

Lines changed: 401 additions & 229 deletions
Large diffs are not rendered by default.

‎ja/advanced/dashboard/permissions.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: エディター権限
3+
description: チームのより多くのメンバーにドキュメントの更新を許可
4+
---
5+
6+
最初のドキュメントを作成したチームメンバーは、Mintlifyにサインアップした時と同じGitHubアカウントでドキュメントリポジトリにプッシュする限り、ドキュメントの更新アクセス権を持ちます。
7+
8+
無料プランで別のエディターがドキュメントを更新しようとすると、gitコミットチェックで警告が表示されます。
9+
10+
<Frame>
11+
<img className="rounded-md" src="/images/editor-gate.png" />
12+
</Frame>
13+
14+
gitチェック警告の詳細には、プランをアップグレードするためのリンクが記載されています。また、[ダッシュボード](https://dashboard.mintlify.com)でプランをアップグレードして、無制限のエディターがドキュメントを更新できるようにすることもできます。プランをアップグレードしたら、手動更新をトリガーするか、別の変更をプッシュして更新をデプロイしてください。
15+
16+
料金についての詳細は[こちら](https://mintlify.com/pricing)をご覧ください。

‎ja/advanced/dashboard/sso.mdx‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: シングルサインオン（SSO）
3+
description: 管理者ダッシュボードへのチームのログイン方法をカスタマイズ
4+
---
5+
6+
SAMLとOIDCを介してダッシュボードへのシングルサインオンを使用します。OktaまたはGoogle Workspaceを使用している場合、SSOの設定に関するプロバイダー固有のドキュメントがありますが、他のプロバイダーを使用している場合は、お問い合わせください！
7+
8+
<Note>
9+
SSO機能はEnterpriseプランで利用可能です。[お問い合わせ](https://mintlify.com/enterprise)で詳細をご確認ください！
10+
</Note>
11+
12+
## Okta
13+
14+
<Tabs>
15+
<Tab title="SAML">
16+
<Steps>
17+
<Step title="Create an application">
18+
の下で、`Applications`SAML 2.0を使用して新しいアプリ統合を作成するためにクリックします。
19+
</Step>
20+
21+
<Step title="Configure integration">
22+
以下を入力します：
23+
24+
* シングルサインオンURL（Mintlifyが提供）
25+
* オーディエンスURI（Mintlifyが提供）
26+
* 名前IDフォーマット：`EmailAddress`
27+
* 属性ステートメント：
28+
| 名前 | 名前フォーマット | 値 |
29+
| ----------- | -------- | ---------------- |
30+
| `firstName` | Basic | `user.firstName` |
31+
| `lastName` | Basic | `user.lastName` |
32+
</Step>
33+
34+
<Step title="Send us your IdP information">
35+
アプリケーションの設定が完了したら、サインオンタブに移動してメタデータURLを送信してください。この情報を使用して、私たちの側で接続を有効にします。
36+
</Step>
37+
</Steps>
38+
</Tab>
39+
40+
<Tab title="OIDC">
41+
<Steps>
42+
<Step title="Create an application">
43+
下記の`Applications`をクリックして、OIDCを使用して新しいアプリ統合を作成します。
44+
以下の`Web Application`アプリケーションタイプを選択してください。
45+
</Step>
46+
47+
<Step title="Configure integration">
48+
認証コードの付与タイプを選択し、Mintlifyから提供されたリダイレクトURIを入力してください。
49+
</Step>
50+
51+
<Step title="Send us your IdP information">
52+
アプリケーションの設定が完了したら、全般タブに移動してクライアントIDとクライアントシークレットを確認してください。
53+
これらの情報と、OktaインスタンスURL（例：`<your-tenant-name>.okta.com`）を安全に提供してください。1PasswordやSendSafelyなどのサービスを通じて送信できます。
54+
</Step>
55+
</Steps>
56+
</Tab>
57+
</Tabs>
58+
59+
## Google Workspace
60+
61+
<Tabs>
62+
<Tab title="SAML">
63+
<Steps>
64+
<Step title="Create an application">
65+
下記の`Web and mobile apps`から`Add custom SAML app`を`Add app`ドロップダウンから選択してください。
66+
67+
<Frame>
68+
![](/images/gsuite-add-custom-saml-app.png)
69+
</Frame>
70+
</Step>
71+
72+
<Step title="Send us your IdP information">
73+
提供されたSSO URL、Entity ID、x509証明書をコピーしてMintlifyチームに送信してください。
74+
75+
<Frame>
76+
![](/images/gsuite-saml-metadata.png)
77+
</Frame>
78+
</Step>
79+
80+
<Step title="Configure integration">
81+
サービスプロバイダーの詳細ページで、以下を入力してください：
82+
83+
* ACS URL（Mintlifyが提供）
84+
* Entity ID（Mintlifyが提供）
85+
* Name IDフォーマット：`EMAIL`
86+
* Name ID：`Basic Information > Primary email`
87+
88+
<Frame>
89+
![](/images/gsuite-sp-details.png)
90+
</Frame>
91+
92+
次のページで、以下の属性ステートメントを入力してください：
93+
94+
| Googleディレクトリ属性 | アプリ属性 |
95+
| -------------- | ----------- |
96+
| `First name` | `firstName` |
97+
| `Last name` | `lastName` |
98+
99+
このステップが完了し、ユーザーがアプリケーションに割り当てられたら、私たちのチームに連絡してください。アカウントのSSOを有効にします！
100+
</Step>
101+
</Steps>
102+
</Tab>
103+
</Tabs>

‎ja/advanced/mcp/generate.mdx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: MCPジェネレーター
3+
description: ドキュメント用のMCPサーバーのセットアップ方法を学ぶ
4+
---
5+
6+
<Tip>
7+
このページでは、独自のドキュメント用のMCPサーバーのセットアップ方法について説明します。Mintlify MCPサーバーの使用に関する情報をお探しの場合は、[Mintlify MCPサーバーのインストールと使用](/advanced/mcp/quickstart)ページをご参照ください。
8+
</Tip>
9+
10+
## はじめに
11+
12+
実行：`npm i @mintlify/mcp`をインストールして`@mintlify/mcp`CLIを使用します。
13+
14+
この[ダッシュボード](https://dashboard.mintlify.com/products/mcp)で、`MCP Server`に移動して、独自のインストールコマンドを確認してください。これは`@mintlify/mcp`CLIでMCPサーバーをインストールするためのコマンドです。
15+
16+
<Note>
17+
MCPサーバーが**すべての**OpenAPI仕様のエンドポイントにアクセスできるように、OpenAPIアクセスを有効にしてください。
18+
</Note>
19+
20+
## MCPサーバーをローカルで起動
21+
22+
<Steps>
23+
<Step title="Install the server through the CLI">
24+
以下のコマンドを実行してサーバーをインストールします：
25+
26+
```bash
27+
npx @mintlify/mcp add [your subdomain]
28+
```
29+
</Step>
30+
31+
<Step title="Add the authentication token if applicable">
32+
APIが認証トークンを必要とする場合、エンドユーザーにトークンを取得してもらい、この応答が表示されたときに適用するように指示してください：`> What is the Authorization
33+
(basic token)?`それ以外の場合は、このステップをスキップできます。
34+
</Step>
35+
36+
<Step title="Start your MCP server">
37+
次のコマンドを実行できます：`bash npm --prefix ~/.mcp/[your subdomain] start `
38+
</Step>
39+
</Steps>

‎ja/advanced/mcp/quickstart.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: クイックスタート
3+
description: 製品をAIアプリに接続するためのMCPサーバーを生成
4+
---
5+
6+
## はじめに
7+
8+
Mintlifyの MCP Generatorは、あなたの会社のドキュメントとOpenAPI仕様（利用可能な場合）に基づいてMCPサーバーを生成するCLIツールです。MCP Generatorは[npmパッケージ](https://www.npmjs.com/package/mcp)として提供されています。
9+
10+
MCPサーバーは、以下の主要なシナリオでMCPクライアントと共に使用できます：
11+
12+
1. **ドキュメントQ\&A**、AI Chatと同様です。これはドキュメントに対して自動的に有効化され、設定は必要ありません。
13+
2. **リアルタイムAPIクエリ**、OpenAPI仕様がある場合は、`Mintlify Dashboard > Products > MCP Server`に移動してトグルを切り替え、OpenAPI仕様を有効にしてください。
14+
15+
<Note>
16+
OpenAPIトグルを有効にすることで、MCPサーバーに
17+
**すべての**OpenAPI仕様のエンドポイントへのアクセスを許可します。
18+
</Note>
19+
20+
## MCPサーバーのインストール
21+
22+
<Tip>
23+
このページはMintlify MCPサーバーのインストールに関するものです。独自のMCPサーバーの生成に関する情報をお探しの場合は、[MCP Generator](/advanced/mcp/generate)のページをご参照ください。
24+
</Tip>
25+
26+
## Mintlify MCPサーバーでのインストール例
27+
28+
Mintlify MCPサーバーを使用するには[APIキー](https://mintlify.com/docs/advanced/rest-api/overview#authentication)が必要です。お持ちでない場合は、`Settings > API Keys > Chat API Key`に移動して新しいキーを作成してください。
29+
30+
## MCPサーバーをローカルで起動
31+
32+
<Steps>
33+
<Step title="Install the server through the CLI">
34+
以下のコマンドを実行してサーバーをインストールします：
35+
36+
```bash
37+
npx @mintlify/mcp@latest add mintlify
38+
```
39+
</Step>
40+
41+
<Step title="Add the authentication token">
42+
前のコマンドを実行すると、以下のレスポンスが表示されます：
43+
44+
```
45+
> What is the Authorization (basic token)?
46+
```
47+
48+
APIチャットキーを使用して、認証トークンをコピーしCLIに貼り付けてください。
49+
</Step>
50+
51+
<Step title="Start your MCP server">
52+
これで以下を実行できます：
53+
54+
```bash
55+
npm --prefix ~/.mcp/mintlify start
56+
```
57+
</Step>
58+
</Steps>
59+
60+
## Claudeでサーバーを使用
61+
62+
<Note>
63+
以下をダウンロード：[Claude デスクトップアプリ](https://claude.ai/download)
64+
</Note>
65+
66+
Claude デスクトップアプリをインストールしたら、以下の手順に従ってください：
67+
68+
<Steps>
69+
<Step title="Navigate to the Settings > Developer" />
70+
71+
<Step title="Click on Edit Config">
72+
以下を`claude_desktop_config.json`に追加してください：
73+
74+
```json
75+
{
76+
"mcpServers": {
77+
"mintlify": {
78+
"command": "npm",
79+
"args": [
80+
"--prefix",
81+
"~/.mcp/mintlify",
82+
"start"
83+
]
84+
}
85+
}
86+
}
87+
```
88+
</Step>
89+
90+
<Step title="If you see the hammer icon, you're all set!">
91+
クリックすると、サーバーで利用可能なMCPツールが表示されます。
92+
93+
<Frame>
94+
![Claude MCP](/images/mcp-with-claude.png)
95+
</Frame>
96+
</Step>
97+
</Steps>

‎ja/advanced/rest-api/chat/create-topic.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/topic
3+
---

‎ja/advanced/rest-api/chat/generate-message.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/message
3+
---

‎ja/advanced/rest-api/overview.mdx‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: 概要
3+
---
4+
5+
## 更新のトリガー
6+
7+
REST APIを活用して、必要に応じてプログラムで更新をトリガーすることができます。
8+
9+
<Info>
10+
主なユースケースは更新のトリガーですが、時間とともにAPIにさらに多くの機能を追加していく予定です。他に見たい機能があれば、
11+
12+
[コミュニティ](https://mintlify.com/community)でお知らせください！
13+
</Info>
14+
15+
## 認証
16+
17+
APIキーは[ダッシュボード](https://dashboard.mintlify.com/settings/organization/api-keys)で生成できます。APIキーは組織全体に関連付けられており、複数のデプロイメントで使用できます。
18+
19+
<Frame>
20+
<img src="/images/external-api-key.png" />
21+
</Frame>
22+
23+
## 管理者APIキー
24+
25+
管理者APIキーはAPIの大部分で使用されます。[更新エンドポイント](/advanced/rest-api/update/trigger)を通じて更新をトリガーするために使用されます。
26+
27+
## チャットAPIキー
28+
29+
チャットAPIを使用すると、ドキュメントに基づいたAIチャット体験を任意のアプリケーションに組み込むことができ、常に最新の状態に保たれます。
30+
31+
レスポンスには引用が含まれているため、ユーザーが必要なヘルプを得るための適切な場所を示すことができます。
32+
33+
<Note>
34+
チャットAPIトークンはフロントエンドコードで参照できる公開トークンですが、APIキーは秘密にしておく必要があるサーバーサイドトークンです。
35+
</Note>
36+
37+
APIキーを取得したら、[例](https://github.com/mintlify/discovery-api-example)をチェックしてAIチャット用のAPIの使用方法を確認してください。また、この例のデプロイ版は[chat.mintlify.com](https://chat.mintlify.com)で見ることができます。

‎ja/advanced/rest-api/update/status.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: GET /project/update-status/{statusId}
3+
---

‎ja/advanced/rest-api/update/trigger.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /project/update/{projectId}
3+
---

0 commit comments

Comments
 (0)