Что получится
Этот шаблон помогает писать MCP-гайды одинаково понятно. Читатель должен не просто скопировать команду, а понять, зачем сервер нужен, какие доступы он получает и как проверить, что всё работает.
Перед установкой
Ответь в начале гайда на четыре вопроса:
| Вопрос | Пример ответа |
|---|---|
| Что делает сервер? | Даёт агенту доступ к GitHub issues |
| Где хранится конфиг? | В настройках клиента или локальном JSON |
| Какие права нужны? | Read-only или write-доступ |
| Как отключить? | Команда удаления или disable |
Базовая структура
- Зачем нужен сервер.
- Что потребуется.
- Как установить.
- Как проверить.
- Как откатить.
- Какие есть риски.
Пример установки
bash
# пример команды установки
agent mcp add example-server --command "example-server"
Проверка
| Шаг | Что подтвердить |
|---|---|
| Установка | Команда завершилась без ошибки |
| Список серверов | Сервер появился в клиенте |
| Мини-тест | Агент может вызвать инструмент |
| Откат | Есть команда удаления или disable |
Ссылку на официальный источник добавляй явно. Например: Model Context Protocol.
Как писать человечески
Не начинай с “MCP представляет собой…”. Лучше так:
text
Этот сервер нужен, если ты хочешь, чтобы агент видел задачи в GitHub и мог связать код с issue без ручного копирования ссылок.
Так читатель быстрее понимает сценарий, а не термин.
Частые ошибки
- не указать, где хранится конфиг;
- не дать команду удаления;
- не объяснить, какие permissions получает сервер;
- не сказать, какие клиенты поддерживаются.
Результат
Хороший MCP-гайд оставляет читателя в состоянии: “я понимаю, зачем это, могу поставить, проверить и откатить без паники”.