Skip to content

Conversation

@koladev32
Copy link
Collaborator

No description provided.

@ritza-publishing-assistant
Copy link

@ritza-publishing-assistant
Copy link

@ritza-publishing-assistant
Copy link

https://github.com/ritza-co/speakeasy-developer-docs/blob/draft/mcp-for-customer-service/mcp/use-cases/mcp-for-customer-service/index.mdx (

  • Front matter: (description: Learn how to use Gram to host MCP servers for internal APIs, creating automated workflows that connect Claude to your existing tools.) – The description refers to “Gram” and “Claude” without clarifying their roles; while not a strict error, it may confuse readers expecting consistent naming.
  • Paragraph under “Introduction”: (…handle more customer complaints. What if you could help more customers faster…) – “customer complaints” and “customers” are used interchangeably and may be inconsistent in tone.
  • Prerequisites section: (…Access to Zendesk and Slack accounts.) – “Slack” is capitalized, which is consistent, but later in the MCP config “SlackMCPServer” is used; consider ensuring naming consistency (e.g. “Slack MCP Server” vs “SlackMCPServer”).
  • Link inconsistency: (Under “Setting Up Zendesk and Slack”: “Using Zendesk with MCP”) – Unlike the Slack guide link which begins with a forward slash, the Zendesk guide link is missing a leading “/”, which might affect routing.
  • Inline command formatting: (…by running the following commandngrok http 127.0.0.1:8000…) – There is no space between “command” and the inline code block; a space should be added for clarity.
  • JSON config – GRAM_KEY value: ( "GRAM_KEY": "Bearer <your-key-here>" ) – The use of backticks inside the quoted string is unconventional; it may be clearer to remove them and use “Bearer ” instead.
  • Consistent API naming: (“License API” vs. “internal API” vs. “internal License API”) – The document uses varying terms for the API; standardizing the term (e.g. always “License API”) would avoid potential confusion.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants