Sync open source content 🐝 (from 84f9f5b1eacf3e3e834b26880064acc0c9d59170)

Author: beezythebot

docs/gram/clients/troubleshooting.mdx

@@ -3,30 +3,30 @@ title: Troubleshooting
 description: Overcome common issues when installing MCP servers.
 ---
 
-Due to the emerging nature of the MCP specification and differences in how
+Due to the emerging nature of the MCP Specification and differences in how
 various LLM providers and client applications implement it, you may encounter
 issues when hosting and using MCP servers with Gram. This troubleshooting guide
 addresses common problems and provides solutions to help you resolve them
 quickly.
 
-### Helpful Resources
+### Helpful resources
 
 The following external resources provide additional context and information
 about MCP, and may be helpful when troubleshooting issues:
 
 - <a href="https://modelcontextprotocol.io/specification/latest"
-  target="_blank" rel="noreferrer">MCP Specification.</a> The
+  target="_blank" rel="noreferrer">MCP Specification:</a> The
   official documentation for the Model Context Protocol (MCP).
-- <a href="https://modelcontextprotocol.io/clients" target="_blank" rel="noreferrer">MCP Client
-  Feature Support Matrix.</a> A list of well-known LLM clients and their level
-  of MCP support. _Many LLM clients to do not support all of Gram MCP Server
+- <a href="https://modelcontextprotocol.io/clients" target="_blank" rel="noreferrer">MCP client
+  feature support matrix:</a> A list of well-known LLM clients and their level
+  of MCP support. _Many LLM clients do not support all of Gram's MCP server
   features_.
 
-## Issues with MCP Remote & Node Environments
+## Issues with MCP remote and Node.js environments
 
 Some LLM clients, such as **Claude**, are not yet able to connect to remote MCP
-servers natively. To overcome this, the `mcp-remote` CLI tool is used to proxy
-requests from the LLM client to hosted MCP servers:
+servers natively. To overcome this, you can use the `mcp-remote` CLI tool to proxy
+requests from an LLM client to hosted MCP servers:
 
 ```json filename="mcp-remote"
 {
@@ -48,21 +48,21 @@ target="blank">reported</a> servers failing to start, with `Client transport
 closed` appearing in client logs.
 
 This is typically due to the LLM client attempting to use an older version of
-Node to execute `mcp-remote` than what is required.
+Node.js than required to execute `mcp-remote`.
 
-#### Solutions
+## Solutions
 
-##### Use Node 20 or Higher (Recommended)
+### Use Node.js 20 or higher (recommended)
 
-Ensure that you are using Node.js version 20 or higher. If you run into issues, check in claude desktop logs for what node version it is selecting. Claude desktop has at times shown a tendency to select the lowest version of Node is can find on your machine, regardless of what the default node version is. Instructions for
+Ensure that you're using Node.js version 20 or higher. If you run into issues, check the Claude Desktop logs to see which Node.js version it is selecting. Claude Desktop has at times shown a tendency to select the lowest version of Node.js it can find on your machine, regardless of the default Node.js version. Instructions for
 installing and managing Node.js versions can be found on the <a
 href="https://nodejs.org/en/download/" target="_blank" rel="noreferrer">official Node.js
 website</a>.
 
-##### Pin `mcp-remote` to Version `0.1.25`
+### Pin `mcp-remote` to version `0.1.25`
 
-If you're not able to install or change to a compatible version of Node, you can pin the
-`mcp-remote` package to version `0.1.25` in your MCP configuration.
+If you're unable to install or change to a compatible version of Node.js, you can pin the
+`mcp-remote` package to version `0.1.25` in your MCP configuration:
 
 ```json ins="@0.1.25"
 {
@@ -78,9 +78,9 @@ If you're not able to install or change to a compatible version of Node, you can
 }
 ```
 
-## Getting Support
+## Getting support
 
-If you're encountering a persistent issue that is not covered in this
+If you're encountering a persistent issue that isn't covered in this
 troubleshooting guide, please reach out to Gram support via the in-app chat, or
 join our <a href="https://go.speakeasy.com/slack" target="_blank" rel="noreferrer">Slack
 community</a> to get help!

docs/gram/command-line.mdx

@@ -1,6 +1,6 @@
 ---
-title: "Gram CLI Overview"
-description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+title: "Gram CLI overview"
+description: "Learn how to install and use the Gram CLI tool."
 asIndexPage: true
 sidebar:
   order: 0
@@ -14,26 +14,28 @@ configure toolsets, deploy servers, and monitor their performance with ease.
 
 ## Installation
 
-**Using `curl`:**
+Install the Gram CLI with one of the following methods:
 
-```
-curl -fsSL https://go.getgram.ai/cli.sh | bash
-```
+- Using curl:
 
-**Using Homebrew:**
+	```
+	curl -fsSL https://go.getgram.ai/cli.sh | bash
+	```
 
-```bash
-brew update
-brew install speakeasy-api/homebrew-tap/gram
-```
+- Using Homebrew:
+
+	```bash
+	brew update
+	brew install speakeasy-api/homebrew-tap/gram
+	```
 
-After installation, verify that the Gram CLI is installed correctly by running:
+After installation, run the following command to verify that the Gram CLI is installed correctly:
 
 ```bash
 gram --version
 ```
 
-Then authenticate with your Gram account:
+Then authenticate yourself with your Gram account:
 
 ```bash
 gram auth
@@ -53,10 +55,10 @@ Then, inspect your current user information:
 gram whoami
 ```
 
-The first time you run `gram auth`, it will create and save a [Producer
+The first time you run `gram auth`, it creates and saves a [Producer
 key](/docs/gram/concepts/api-keys#producer-keys) in your Gram dashboard.
 
-## Available Commands
+## Available commands
 
 <div className="grid md:grid-cols-4 sm:grid-cols-2 gap-4 w-[42rem] mx-auto">
     <a href="/docs/gram/command-line/auth">- auth</a>
@@ -70,71 +72,71 @@ key](/docs/gram/concepts/api-keys#producer-keys) in your Gram dashboard.
     <a href="/docs/gram/command-line/whoami">- whoami</a>
 </div>
 
-## Global CLI Options
+## Global CLI options
 
-Global options can be provided to any Gram CLI command.
+You can provide any Gram CLI command with the following global options.
 
 ### <code>api-key</code>
 
-Your Gram API key (must be scoped as a 'Provider').
+Use `api-key` to provide your Gram API key (which must be scoped as a 'Provider'):
 
 ```bash
 gram push --api-key MY_API_KEY [command options]
 ```
 
-When this option is not provided, the CLI will fallback to using the following
+When this option is not provided, the CLI falls back to using the following
 values, in this order:
 
-- The `GRAM_API_KEY` environment variable.
-- The `secret` field of the current profile in `~/.gram/profile.json`.
+- The `GRAM_API_KEY` environment variable
+- The `secret` field of the current profile in `~/.gram/profile.json`
 
 ### <code>project</code>
 
-The slug of the target Gram project.
+Use `project` to provide your target Gram project's slug:
 
 ```bash
 gram push --project my-project [command options]
 ```
 
-When this option is not provided, the CLI will fallback to using the following
+When this option is not provided, the CLI falls back to using the following
 values, in this order:
 
-- The `GRAM_PROJECT` environment variable.
-- The `defaultProjectSlug` field of the current profile in `~/.gram/profile.json`.
+- The `GRAM_PROJECT` environment variable
+- The `defaultProjectSlug` field of the current profile in `~/.gram/profile.json`
 
 ### <code>log-level</code>
 
-Set the base log level. (default: "info")
+Use `log-level` to set the base log level (the default is `info`):
 
 ```bash
 gram [command] --log-level debug [command options]
 ```
 
-Can also be set via the `GRAM_LOG_LEVEL` environment variable.
+You can also set the base log level via the `GRAM_LOG_LEVEL` environment variable.
 
 ### <code>log-pretty</code>
 
-Toggle pretty logging. (default: true)
+Use `log-pretty` to toggle pretty logging off. (By default, this option is set to `true`.)
 
 ```bash
 gram [command] --log-pretty=false [command options]
 ```
 
-Can also be set via the `GRAM_LOG_PRETTY` environment variable.
+You can also enable and disable pretty logging set via the `GRAM_LOG_PRETTY` environment variable.
 
 ### <code>profile</code>
 
-Profile name to use from `~/.gram/profile.json`.
+Use `profile` to provide the profile name to use from `~/.gram/profile.json`:
 
 ```bash
 gram [command] --profile production [command options]
 ```
 
-Can also be set via the `GRAM_PROFILE` environment variable.
+You can also set the profile name via the `GRAM_PROFILE` environment variable.
 
 ### <code>help</code>
 
-Show help information for any command.
+Use `help` to view the help information for any command:
 
 ```bash
 gram [command] --help
@@ -144,7 +146,7 @@ Short form: `-h`
 
 ### <code>version</code>
 
-Print the version of the Gram CLI.
+Use `version` to print the version of the Gram CLI.
 
 ```bash
 gram --version

docs/gram/command-line/auth.mdx

@@ -1,18 +1,18 @@
 ---
 title: gram auth
-description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+description: "Authenticate with Gram from the CLI."
 ---
 
 import { Callout } from '@/mdx/components'
 
 The `auth` command authenticates with the Gram platform by opening a browser
 window for login. After successful authentication, it creates and saves a
-[Producer API key](/docs/gram/concepts/api-keys#producer-keys) to the local
+[Producer API key](/docs/gram/concepts/api-keys#producer-keys) for the local
 profile configuration.
 
 <Callout type="info">
     The `gram auth` command is typically run once during initial setup. The
-    created API key and profile information are stored in
+    API key and profile information it creates are stored in
     `~/.gram/profile.json`.
 </Callout>
 
@@ -26,13 +26,13 @@ gram auth
 
 This command will:
 
-1. Open a browser window to the Gram authentication page
-2. Prompt for login credentials
-3. Create a Producer API key in the Gram dashboard
-4. Saves the API key and profile information locally
-5. Saves the current project in the browser as your default project
+- Open a browser window to the Gram authentication page
+- Prompt for login credentials
+- Create a Producer API key in the Gram dashboard
+- Save the API key and profile information locally
+- Save the current project in the browser as your default project
 
-After authentication, verify the setup with [gram whoami](/docs/gram/command-line/whoami).
+After authentication, verify the setup with [`gram whoami`](/docs/gram/command-line/whoami).
 
 ## Subcommands
 
@@ -51,11 +51,11 @@ gram auth clear
 
 ### <code>api-url</code>
 
-The URL of the Gram web application. This option is useful for connecting to
+This option adds the URL of a Gram web application. It's useful for connecting to
 custom or self-hosted Gram instances.
 
 ```bash
 gram auth --api-url https://custom.gram.instance [other options]
 ```
 
-Can also be set via the `GRAM_API_URL` environment variable.
+You can also set the URL of a Gram web app via the `GRAM_API_URL` environment variable.