문서 사이트

AI로 문서 작성 (MCP·SDK)

MCP 도구와 TypeScript SDK로 Docs 사이트와 페이지를 관리합니다.

AI 작성 흐름

조직 관리 API 키에 docs:read와 docs:write scope를 부여해 문서 사이트를 관리합니다. 먼저 사이트와 페이지를 조회하고, 변경 뒤 최신 revision을 기준으로 저장합니다. 검토가 끝난 경우에만 게시를 호출하세요.

가이드를 읽습니다

get_doc_authoring_guide로 컴포넌트 문법과 작성 규칙을 확인합니다.

사이트와 페이지를 조회합니다

list_doc_sites, list_doc_pages, get_doc_page를 사용합니다.

초안을 작성합니다

페이지 생성·수정 도구에 Markdown 또는 정규화된 JSON을 전달합니다.

변경을 확인하고 게시합니다

사용자의 검토가 끝난 뒤 publish_doc_site를 호출합니다.

AI 도구는 실제 변경을 수행합니다. 게시, 삭제, 도메인 변경은 사용자 승인을 받은 뒤 요청하세요.

MCP 도구

읽기 도구는 docs:read 또는 admin:read, 쓰기 도구는 docs:write 또는 admin:write scope를 요구합니다. 도구는 조직 키 전용이며 project-bound key로는 사용할 수 없습니다.

용도	도구
가이드·사이트 조회	`get_doc_authoring_guide`, `list_doc_sites`, `get_doc_site`
페이지·릴리스 조회	`list_doc_pages`, `get_doc_page`, `list_doc_releases`
사이트·내비게이션 변경	`create_doc_site`, `update_doc_site`, `delete_doc_site`, `set_doc_navigation`
페이지 변경	`create_doc_page`, `update_doc_page`, `delete_doc_page`
게시·복원	`publish_doc_site`, `restore_doc_release`

사이트 설정·페이지 스키마는 Docs API에서 확인할 수 있습니다.

SDK 시작

bash

npm install @the-seeker/docs-sdk

typescript

import { createDocsClient } from "@the-seeker/docs-sdk";

const docs = createDocsClient({ apiKey: process.env.CRM_DOCS_API_KEY! });
const { page, warnings, created } = await docs.pages.upsertByPath(
  "site-id",
  "guides/quickstart",
  { title: "빠른 시작", markdown: "## 시작하기\n\n첫 문서입니다.\n" },
);

SDK 오류, timeout, 입력 계약은 Docs SDK를 참고하세요.

이 페이지가 도움이 되었나요?