Skip to content

Commit a7dd350

Browse files
committed
MCP doc edits
1 parent e5eb013 commit a7dd350

File tree

3 files changed

+37
-31
lines changed

3 files changed

+37
-31
lines changed

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ 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+
## Overview
18+
19+
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.
1820

1921
## Learning Objectives
2022

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

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

2830
## Prerequisites
2931

30-
- [Bun] - the JavaScript runtime
31-
- [Flow MCP server] - the Flow MCP server repository
32+
- [Bun] - the JavaScript runtime.
33+
- [Flow MCP server] - the Flow MCP server repository.
3234

3335
## Installation
3436

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

37-
2. Clone the repository
39+
2. Clone the repository:
3840

3941
```bash
4042
git clone https://github.com/your-username/flow-mcp.git
4143
```
4244

43-
3. Install the dependencies
45+
3. Install the dependencies:
4446

4547
```bash
4648
bun install
4749
```
4850

49-
4. Build the project
51+
4. Build the project:
5052

5153
```bash
5254
bun build
5355
```
5456

5557
## Create new Action Tool for Flow MCP
5658

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

5961
```bash
6062
mkdir src/tools/your-tool-name
@@ -75,9 +77,9 @@ After completing this tutorial, you should be able to:
7577

7678
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.
7779

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.
80+
And we recommended that you add a test for your new tool in the `src/tools/your-tool-name/your-tool.test.ts` file.
7981

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.
82+
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.
8183

8284
4. Add your new tool to the `src/tools/index.ts` file.
8385

@@ -90,15 +92,15 @@ After completing this tutorial, you should be able to:
9092
};
9193
```
9294

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

9597
```bash
9698
bun test
9799
```
98100

99101
6. Commit and push your changes to your forked repository, and create a pull request.
100102

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

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,23 @@ 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+
## Overview
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+
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.
20+
21+
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.
2022

2123
## [Use Flow MCP in Cursor]
2224

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.
25+
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.
2426

2527
## [Contribute to Flow MCP]
2628

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.
29+
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.
2830

2931
## Conclusion
3032

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.
33+
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.
3234

3335
<!-- Reference-style links, will not render on page. -->
3436

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ keywords:
2626
></iframe>
2727
</div>
2828
29+
## Overview
30+
2931
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).
3032

31-
Specifically, it enables you to:
33+
Specifically, it lets you:
3234

3335
- Ask the AI in Cursor to fetch onchain data such as account balances, account information, or contract source code without leaving your editor.
3436
- Speed up development by letting AI perform blockchain queries that would normally require manual steps.
@@ -40,18 +42,18 @@ This tutorial will guide you through setting up and using Flow MCP in [Cursor] t
4042

4143
## Learning Objectives
4244

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

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

5153
## Prerequisites
5254

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

5658
## Installation
5759

@@ -82,7 +84,7 @@ After completing this tutorial, you should be able to:
8284

8385
3. Restart Cursor to load the new MCP configuration.
8486

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.
87+
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.
8688

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

@@ -104,11 +106,11 @@ After completing this tutorial, you should be able to:
104106

105107
If you encounter any issues:
106108

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
109+
1. Ensure the MCP server is properly installed.
110+
2. Verify the configuration file is in the correct location.
111+
3. Check that the paths in the configuration are correct.
112+
4. Try restarting Cursor.
113+
5. Check the console for any error messages.
112114

113115
## Additional Resources
114116

@@ -120,8 +122,8 @@ If you encounter any issues:
120122

121123
For issues or questions:
122124

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

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

0 commit comments

Comments
 (0)