Inkeep Content Writer

Overview

The Inkeep Content Writer ensures that your documentation is comprehensive and up-to-date with the latest production changes.

Given a GitHub pull request or a solved Zendesk support ticket, the Content Writer will analyze your documentation for gaps and generate updates for you to review and publish.

You can also request documentation changes directly from Slack by mentioning @inkeep.

Customizing the Content Writer

The Inkeep team will deploy and set up the Content Writer in your Inkeep Enterprise tenant. Once set up, you can fully customize the agent to fit your needs.

Customization options include:

• Skills: Reusable instructions like style guides and best practices that you can attach to sub-agents.
• Prompts: Tailored prompts that sub-agents use to coordinate documentation updates.
• Tools: Tools give the Content Writer access to external systems and services that it can use to research and ground its output.
• Output CMS: The CMS where the documentation updates will be published, such as GitHub, Zendesk, or Notion.
• Triggers: The events that trigger the Content Writer.

GitHub integration

Use the GitHub integration to trigger the Content Writer on merged pull requests or when you mention @inkeep in a pull request comment or review.

Required permissions and app installation

To use Content Writer with GitHub, install the GitHub Work App and grant it access to the necessary repositories.

The GitHub App requests the following permissions:

Follow the steps below to install and configure the GitHub Work App.

Install the Inkeep GitHub app

From app.inkeep.com/<your-tenant-id>/work-apps/github, click Connect GitHub Organization.

Add the Content Writer workflow

Add the following workflow to each repository where you want comment-based or merge-based triggers.

name: Inkeep Content Writer

on:
  pull_request:
    types: [closed]
  issue_comment:
    types: [created]
  pull_request_review_comment:
    types: [created]
  pull_request_review:
    types: [submitted]

permissions:
  contents: read
  pull-requests: write
  id-token: write

jobs:
  trigger-agent:
    if: |
      (github.event_name == 'pull_request' && github.event.pull_request.merged == true && github.event.pull_request.user.login != 'inkeep[bot]') ||
      (
        (github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@inkeep') &&
         (github.event.comment.author_association == 'OWNER' || github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'COLLABORATOR')) ||
        (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@inkeep') &&
         (github.event.comment.author_association == 'OWNER' || github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'COLLABORATOR')) ||
        (github.event_name == 'pull_request_review' && contains(github.event.review.body || '', '@inkeep') &&
         (github.event.review.author_association == 'OWNER' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'COLLABORATOR'))
      )
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Inkeep Agent
        uses: inkeep/inkeep-agents-action@fbbc92842bd025f044cb7e4d827882fd85914f26
        with:
          trigger-url: ${{ secrets.INKEEP_CONTENT_WRITER_TRIGGER_URL }}
          # Filters out PRs that don't match the given regex. Update regex as desired or remove entirely
          pr-title-regex: '^(feat|fix|docs|chore)(\(.+\))?:'

Store the trigger URL

Add the Content Writer trigger URL to your repository secrets as INKEEP_CONTENT_WRITER_TRIGGER_URL. The trigger URL can be found at https://app.inkeep.com/<your-tenant-id>/projects/content-writer/triggers?tab=webhooks.

Triggering the Content Writer from GitHub

The workflow triggers the Content Writer in the following cases:

• Mention @inkeep in a pull request comment, review comment, or review body to provide feedback to the Content Writer.
• Merge a pull request to trigger post-merge content follow-up.

The Inkeep team can help you customize the GitHub workflow to fit your needs.

Zendesk integration

Use the Zendesk integration to trigger the Content Writer from support tickets.

Create a Zendesk role

Create a custom Zendesk role for the service account that the Content Writer will use.

Create a Zendesk service account

Create a Zendesk team member that Content Writer will use to access ticket data.

Add the service account to groups

Add the Zendesk service account to the groups that contain the tickets Content Writer should be able to read.

Create an API token

Create an API token for the Zendesk service account.

Connect to the Zendesk MCP

Connect the Zendesk service account token to the Zendesk MCP server in Inkeep.

Open your Content Writer project

Log in to Inkeep Enterprise and open your Content Writer project.

Create a bearer credential

In the left-hand menu, click Credentials → New → Bearer Authentication.

Fill in credential details

Use these values:

Field	Value
Name	A credential name, such as Zendesk Content Writer Integration
API Key	The API token for the Zendesk service account created previously

Add Zendesk headers

Under Headers, add:

Header	Value
x-zendesk-email	The service account email address
x-zendesk-subdomain	Your Zendesk subdomain. For yourcompany.zendesk.com, use yourcompany.

Link the credential to the MCP server

Check Link this credential to an MCP server, then select the Zendesk MCP server from the dropdown.

Create the Zendesk webhook trigger

Create a Zendesk webhook that sends ticket updates to the Content Writer.

Customize the Zendesk trigger

In the following example, the trigger is configured to send solved tickets with the inkeep_content_writer tag to the Content Writer. The Inkeep team can help you customize the trigger to fit your needs.

{"ticket_id":"{{ticket.id}}"}