Skip to content

Commit 905c684

Browse files
authored
Merge pull request #1544 from onflow/mcp_doc_edits_cws
MCP doc edits
2 parents df0ee64 + cc32c57 commit 905c684

File tree

3 files changed

+38
-38
lines changed

3 files changed

+38
-38
lines changed

docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/contribute-to-mcp.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ keywords:
1414

1515
# Contribute to Flow MCP
1616

17-
This tutorial will guide you through the process of contributing to the Flow MCP server. The [Model Context Protocol (MCP)] is an open standard developed by Anthropic that enables AI applications to interact seamlessly with external tools, systems, and data sources.
17+
This tutorial will guide you through the process of contributing to the Flow MCP server. The [Model Context Protocol (MCP)] is an open standard developed by Anthropic that allows AI applications to interact seamlessly with external tools, systems, and data sources.
1818

19-
## Learning Objectives
19+
## Learning objectives
2020

21-
After completing this tutorial, you should be able to:
21+
After you complete this tutorial, you should be able to:
2222

2323
- Set up and build the Flow MCP server development environment.
2424
- Create and register a new Action Tool, including schema, handler, and tests.
@@ -27,34 +27,34 @@ After completing this tutorial, you should be able to:
2727

2828
## Prerequisites
2929

30-
- [Bun] - the JavaScript runtime
31-
- [Flow MCP server] - the Flow MCP server repository
30+
- [Bun] - the JavaScript runtime.
31+
- [Flow MCP server] - the Flow MCP server repository.
3232

3333
## Installation
3434

35-
1. Fork the [Flow MCP server] repository
35+
1. Fork the [Flow MCP server] repository.
3636

37-
2. Clone the repository
37+
2. Clone the repository:
3838

3939
```bash
4040
git clone https://github.com/your-username/flow-mcp.git
4141
```
4242

43-
3. Install the dependencies
43+
3. Install the dependencies:
4444

4545
```bash
4646
bun install
4747
```
4848

49-
4. Build the project
49+
4. Build the project:
5050

5151
```bash
5252
bun build
5353
```
5454

55-
## Create new Action Tool for Flow MCP
55+
## Create new action tool for Flow MCP
5656

57-
1. Create a new folder in the `src/tools` directory
57+
1. Create a new folder in the `src/tools` directory:
5858

5959
```bash
6060
mkdir src/tools/your-tool-name
@@ -75,9 +75,9 @@ After completing this tutorial, you should be able to:
7575

7676
If you want to add new Cadence files for your new tool, you can add them in the `src/cadence` directory. The `bun` will compile the Cadence files into `String`, so the dedicated Cadence files will help the project to be more organized.
7777

78-
And it is recommended to add a test for your new tool in the `src/tools/your-tool-name/your-tool.test.ts` file.
78+
And we recommended that you add a test for your new tool in the `src/tools/your-tool-name/your-tool.test.ts` file.
7979

80-
3. Add a prompt export in the `src/prompts` directory which is used to ensure MCP client can understand the new tool. You can refer to the existing tools for examples.
80+
3. Add a prompt export in the `src/prompts` directory which is used to confirm that MCP clients can understand the new tool. You can refer to the existing tools for examples.
8181

8282
4. Add your new tool to the `src/tools/index.ts` file.
8383

@@ -90,15 +90,15 @@ After completing this tutorial, you should be able to:
9090
};
9191
```
9292

93-
5. Run the test to ensure your new tool works as expected
93+
5. Run the test to confirm your new tool works as expected:
9494

9595
```bash
9696
bun test
9797
```
9898

9999
6. Commit and push your changes to your forked repository, and create a pull request.
100100

101-
We will review your pull request and merge it if it is ready.
101+
We will review your pull request and merge it if it's ready.
102102
103103
[Flow MCP server]: https://github.com/outblock/flow-mcp
104104
[Bun]: https://bun.sh/

docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ keywords:
1414

1515
# Flow MCP (Model Context Protocol)
1616

17-
The Model Context Protocol (MCP) is an open standard that enables AI applications to interact seamlessly with external tools, systems, and data sources. Flow MCP extends this protocol to provide AI tools with direct access to Flow blockchain data, smart contracts, and onchain operations. This integration allows developers to enhance their AI-powered development workflows with real-time blockchain information and automated Flow interactions.
17+
The Model Context Protocol (MCP) is an open standard that allows AI applications to interact seamlessly with external tools, systems, and data sources. Flow MCP extends this protocol to provide AI tools with direct access to Flow blockchain data, smart contracts, and onchain operations. This integration allows developers to enhance their AI-powered development workflows with real-time blockchain information and automated Flow interactions.
1818

19-
Flow MCP transforms how developers work with the Flow blockchain by bringing blockchain capabilities directly into AI-powered code editors and development tools, eliminating the need to switch between different interfaces and enabling more efficient, context-aware development experiences.
19+
Flow MCP transforms how developers work with the Flow blockchain by bringing blockchain capabilities directly into AI-powered code editors and development tools, which eliminates the need to switch between different interfaces and allows more efficient, context-aware development experiences.
2020

2121
## [Use Flow MCP in Cursor]
2222

23-
Learn how to integrate the Flow MCP server with Cursor to enable AI-driven blockchain queries directly within your code editor. This tutorial guides you through setting up Flow MCP in Cursor, allowing the AI to fetch onchain data such as account balances, contract information, and blockchain state without leaving your development environment. By the end of this tutorial, you'll be able to ask Cursor's AI to perform Flow blockchain operations, speed up development workflows, and access live blockchain data for enhanced debugging and prototyping.
23+
Learn how to integrate the Flow MCP server with Cursor to turn on AI-driven blockchain queries directly within your code editor. This tutorial guides you through how to set up Flow MCP in Cursor, which allows the AI to fetch onchain data such as account balances, contract information, and blockchain state without leaving your development environment. By the end of this tutorial, you'll be able to ask Cursor's AI to perform Flow blockchain operations, speed up development workflows, and access live blockchain data for enhanced debugging and prototyping.
2424

2525
## [Contribute to Flow MCP]
2626

27-
Discover how to extend the Flow MCP server by creating custom Action Tools that add new blockchain interaction capabilities. This comprehensive guide walks you through the development process, from setting up the development environment to submitting pull requests for new features. Learn to create new tools with proper schemas, handlers, and tests, while following Flow MCP's contribution guidelines. This tutorial empowers developers to expand the Flow MCP ecosystem by adding specialized blockchain tools that benefit the entire Flow developer community.
27+
Discover how to extend the Flow MCP server by creating custom Action Tools that add new blockchain interaction capabilities. This comprehensive guide walks you through the development process, from how to set up the development environment to how to submit pull requests for new features. Learn to create new tools with proper schemas, handlers, and tests, while following Flow MCP's contribution guidelines. This tutorial empowers developers to expand the Flow MCP ecosystem by adding specialized blockchain tools that benefit the entire Flow developer community.
2828

2929
## Conclusion
3030

31-
Flow MCP bridges the gap between AI development tools and blockchain functionality, enabling developers to access Flow's comprehensive blockchain features directly through AI-powered interfaces. Whether you're using existing MCP tools in Cursor or contributing new capabilities to the Flow MCP server, these tutorials provide the foundation for integrating blockchain operations into your AI-enhanced development workflow.
31+
Flow MCP bridges the gap between AI development tools and blockchain functionality, which allows developers to access Flow's comprehensive blockchain features directly through AI-powered interfaces. Whether you're using MCP tools in Cursor or contributing new capabilities to the Flow MCP server, these tutorials provide the foundation for integrating blockchain operations into your AI-enhanced development workflow.
3232

3333
<!-- Reference-style links, will not render on page. -->
3434

docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/use-mcp-in-cursor.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ keywords:
2828
2929
Adding Flow MCP to Cursor gives you powerful AI-driven tools directly inside your code editor. It allows Cursor's AI to understand, query, and interact with Flow blockchain data and smart contracts through a standard protocol called the Model Context Protocol (MCP).
3030

31-
Specifically, it enables you to:
31+
Specifically, it lets you:
3232

3333
- Ask the AI in Cursor to fetch onchain data such as account balances, account information, or contract source code without leaving your editor.
3434
- Speed up development by letting AI perform blockchain queries that would normally require manual steps.
@@ -38,20 +38,20 @@ Specifically, it enables you to:
3838

3939
This tutorial will guide you through setting up and using Flow MCP in [Cursor] to enhance your Flow blockchain development experience with AI assistance.
4040

41-
## Learning Objectives
41+
## Learning objectives
4242

43-
After completing this tutorial, you should be able to:
43+
After you complete this tutorial, you should be able to:
4444

4545
- Configure Cursor to connect with the Flow MCP server using the MCP protocol.
4646
- Install and launch the Flow MCP server locally through Cursor.
47-
- Identify when Flow MCP tools are successfully loaded and ready inside Cursor.
47+
- Identify when Flow MCP tools successfully load and are ready inside Cursor.
4848
- Use Flow MCP tools to retrieve blockchain data such as account balances, account details, and contract source code.
4949
- Troubleshoot common setup and connectivity issues between Cursor and Flow MCP.
5050

5151
## Prerequisites
5252

53-
- [Cursor] - the AI code editor
54-
- [Flow MCP GitHub Repository] - the Flow MCP server repository
53+
- [Cursor] - the AI code editor.
54+
- [Flow MCP GitHub Repository] - the Flow MCP server repository.
5555

5656
## Installation
5757

@@ -82,35 +82,35 @@ After completing this tutorial, you should be able to:
8282

8383
3. Restart Cursor to load the new MCP configuration.
8484

85-
You need to wait for the MCP server to start. Once it's ready, you will see there will be a green spot in the left side of `flow-mcp` server name label and all tools for Flow MCP will be displayed.
85+
You need to wait for the MCP server to start. After it's ready, a green spot appears in the left side of `flow-mcp` server name label, and all tools for Flow MCP display.
8686

8787
![Flow MCP server ready](./imgs/flow-mcp-enabled.png)
8888

8989
## How to use Flow MCP in Cursor
9090

91-
### Checking Flow Balance
91+
### Check Flow balance
9292

9393
![Sample Image 1](./imgs/sample-1.png)
9494

95-
### Viewing Account Information
95+
### View account information
9696

9797
![Sample Image 2](./imgs/sample-2.png)
9898

99-
### Getting Contract Source Code
99+
### Get contract source code
100100

101101
![Sample Image 3](./imgs/sample-3.png)
102102

103103
## Troubleshooting
104104

105105
If you encounter any issues:
106106

107-
1. Ensure the MCP server is properly installed
108-
2. Verify the configuration file is in the correct location
109-
3. Check that the paths in the configuration are correct
110-
4. Try restarting Cursor
111-
5. Check the console for any error messages
107+
1. Ensure the MCP server is properly installed.
108+
2. Verify the configuration file is in the correct location.
109+
3. Check that the paths in the configuration are correct.
110+
4. Try restarting Cursor.
111+
5. Check the console for any error messages.
112112

113-
## Additional Resources
113+
## Additional resources
114114

115115
- [Flow MCP GitHub Repository]
116116
- [Cursor Documentation]
@@ -120,8 +120,8 @@ If you encounter any issues:
120120

121121
For issues or questions:
122122

123-
- Open an issue on the [Flow MCP GitHub Repository]
124-
- Join the [Flow Discord] community
123+
- Open an issue on the [Flow MCP GitHub Repository].
124+
- Join the [Flow Discord] community.
125125

126126
[Cursor]: https://www.cursor.com/
127127
[Flow MCP GitHub Repository]: https://github.com/outblock/flow-mcp

0 commit comments

Comments
 (0)