Skip to content

Commit ae173a8

Browse files
committed
chore: refactor for punctuation, spelling and clarity
1 parent 0941637 commit ae173a8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+2191
-2301
lines changed

.editorconfig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ end_of_line = lf
1010
charset = utf-8
1111
trim_trailing_whitespace = true
1212
insert_final_newline = true
13+
max_line_length = 80

.github/instructions/docs.instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ applyTo: "docs/**/*.mdx, !docs/api/**/*.mdx"
55
Focus on documentation clarity and accuracy, ensuring that instructions are easy
66
to follow and understand by a technical audience. Avoid suggesting changes that
77
involve deleting existing content unless it is outdated or incorrect.
8+
9+
When making changes to the documentation, be sure to honor the settings in .editorconfig.
10+
When editing markdown or .MDX files, ignore the line length limit in bullet points, tables,
11+
code blocks and front-matter.

docs/ai-solutions/overview.mdx

Lines changed: 26 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,45 @@ description: Use the Plane MCP server to integrate with Plane
55
sidebar_position: 1
66
---
77

8-
{frontMatter.description && <h3 className="description">{frontMatter.description}</h3>}
8+
{frontMatter.description && (
9+
<h3 className="description">{frontMatter.description}</h3>
10+
)}
911

1012
## Introduction
1113

12-
The [Model Context Protocol](https://modelcontextprotocol.io/overview) (MCP) is
13-
a standardized interface that enables AI models to communicate with external
14-
tools and services. When combined with Server-Sent Events (SSE), it provides a
15-
powerful mechanism for real-time data transfer between AI models and external
16-
systems.
14+
The [Model Context Protocol](https://modelcontextprotocol.io/overview) (MCP) is a
15+
standardized interface that enables AI models to communicate with external tools and
16+
services. When combined with Server-Sent Events (SSE), it provides a powerful
17+
mechanism for real-time data transfer between AI models and external systems.
1718

1819
:::tip Alpha
1920
The Plane MCP Server is currently in **Alpha**. Some aspects of the API may change.
20-
While MCP is standardized, it is also rapidly evolving. The Plane MCP Server
21-
aims to provide a stable implementation that can be used by developers to build
22-
robust applications that leverage the power of AI.
23-
Please send feedback to [email protected].
21+
While MCP is standardized, it is also rapidly evolving. The Plane MCP Server aims to
22+
provide a stable implementation for developers to build robust AI-powered
23+
applications. Please send feedback to [email protected].
2424
:::
2525

2626
## Using the Plane MCP Server
2727

28-
Follow the steps below to integrate with the Plane MCP Server.
28+
Follow these steps to integrate with the Plane MCP Server.
2929

3030
### Claude.ai
3131

3232
- Open **Settings** from the sidebar on the web or desktop app.
33-
- Scroll down to the **Integrations** section and click **Add more**.
34-
- Enter the following Integration URL: `https://mcp.plane.so/sse`
33+
- Scroll to the **Integrations** section and click **Add more**.
34+
- Enter the Integration URL: `https://mcp.plane.so/sse`
3535
- Click **Connect** to link your Plane workspace.
3636

3737
### Claude Desktop
3838

39-
You can add Plane to [Claude
40-
Desktop](https://modelcontextprotocol.io/quickstart/user) by updating your
41-
`claude_desktop_config.json`:
39+
Add Plane to [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) by
40+
updating your `claude_desktop_config.json`:
4241

4342
```json
4443
{
4544
"mcpServers": {
4645
"plane": {
47-
"command": "npx",
46+
"command": "npx",
4847
"args": ["mcp-remote", "https://mcp.plane.so/sse"]
4948
}
5049
}
@@ -53,48 +52,37 @@ Desktop](https://modelcontextprotocol.io/quickstart/user) by updating your
5352

5453
### VSCode
5554

56-
You can also connect Plane to
57-
[VSCode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
55+
Connect Plane to [VSCode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
5856
by editing your `.vscode.json` or `mcp.json` file:
5957

6058
```json
6159
{
6260
"servers": {
6361
"plane": {
64-
"command": "npx",
62+
"command": "npx",
6563
"args": ["mcp-remote", "https://mcp.plane.so/sse"]
6664
}
6765
}
6866
}
6967
```
7068

71-
If you face any issues with Plane Auth, please run the command below in the
72-
terminal to remove stale auth tokens. Then, restart the server. MCP Remote
73-
servers are still experimental.
69+
If you encounter issues with Plane Auth, run the following command in your terminal to
70+
remove stale auth tokens, then restart the server. MCP Remote servers are still
71+
experimental.
7472

7573
```bash
7674
rm -rf ~/.mcp-auth/mcp-remote-*
7775
```
7876

7977
## Activating the Plane MCP Server
8078

81-
After following the above steps, when activating the server, you will be
82-
prompted via your browser to connect your Plane workspace to the MCP server.
79+
After setup, when activating the server, you will be prompted in your browser to
80+
connect your Plane workspace to the MCP server.
8381

84-
When prompted to authorize, click "**Approve**".
82+
When prompted to authorize, click **Approve**.
8583

86-
import Approve from '@site/static/images/mcp/approve.png';
87-
88-
<img style={{width: '600px'}} className="center" src={Approve} alt="authorization" />
89-
90-
<br/>
91-
<br/>
92-
Next, choose the workspace to which you want to connect, review the permissions
93-
and click "**Accept**".
94-
95-
import Accept from '@site/static/images/mcp/accept.png';
96-
97-
<img style={{width: '600px'}} className="center" src={Accept} alt="accept" />
84+
Next, choose the workspace you want to connect, review the permissions, and click
85+
**Accept**.
9886

9987
## Congrats!
10088

0 commit comments

Comments
 (0)