diff --git a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/contribute-to-mcp.md b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/contribute-to-mcp.md index 62e835478f..3aff24b55c 100644 --- a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/contribute-to-mcp.md +++ b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/contribute-to-mcp.md @@ -14,11 +14,11 @@ keywords: # Contribute to Flow MCP -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. +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. -## Learning Objectives +## Learning objectives -After completing this tutorial, you should be able to: +After you complete this tutorial, you should be able to: - Set up and build the Flow MCP server development environment. - 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: ## Prerequisites -- [Bun] - the JavaScript runtime -- [Flow MCP server] - the Flow MCP server repository +- [Bun] - the JavaScript runtime. +- [Flow MCP server] - the Flow MCP server repository. ## Installation -1. Fork the [Flow MCP server] repository +1. Fork the [Flow MCP server] repository. -2. Clone the repository +2. Clone the repository: ```bash git clone https://github.com/your-username/flow-mcp.git ``` -3. Install the dependencies +3. Install the dependencies: ```bash bun install ``` -4. Build the project +4. Build the project: ```bash bun build ``` -## Create new Action Tool for Flow MCP +## Create new action tool for Flow MCP -1. Create a new folder in the `src/tools` directory +1. Create a new folder in the `src/tools` directory: ```bash mkdir src/tools/your-tool-name @@ -75,9 +75,9 @@ After completing this tutorial, you should be able to: 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. - And it is recommended to add a test for your new tool in the `src/tools/your-tool-name/your-tool.test.ts` file. + And we recommended that you add a test for your new tool in the `src/tools/your-tool-name/your-tool.test.ts` file. -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. +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. 4. Add your new tool to the `src/tools/index.ts` file. @@ -90,7 +90,7 @@ After completing this tutorial, you should be able to: }; ``` -5. Run the test to ensure your new tool works as expected +5. Run the test to confirm your new tool works as expected: ```bash bun test @@ -98,7 +98,7 @@ After completing this tutorial, you should be able to: 6. Commit and push your changes to your forked repository, and create a pull request. -We will review your pull request and merge it if it is ready. +We will review your pull request and merge it if it's ready. [Flow MCP server]: https://github.com/outblock/flow-mcp [Bun]: https://bun.sh/ diff --git a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/index.md b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/index.md index 01100e52c7..0e17252aa6 100644 --- a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/index.md +++ b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/index.md @@ -14,21 +14,21 @@ keywords: # Flow MCP (Model Context Protocol) -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. +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. -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. +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. ## [Use Flow MCP in Cursor] -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. +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. ## [Contribute to Flow MCP] -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. +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. ## Conclusion -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. +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. diff --git a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/use-mcp-in-cursor.md b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/use-mcp-in-cursor.md index 7aaf7c7fb0..39babcef7f 100644 --- a/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/use-mcp-in-cursor.md +++ b/docs/blockchain-development-tutorials/use-AI-to-build-on-flow/mcp/use-mcp-in-cursor.md @@ -28,7 +28,7 @@ keywords: 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). -Specifically, it enables you to: +Specifically, it lets you: - Ask the AI in Cursor to fetch onchain data such as account balances, account information, or contract source code without leaving your editor. - Speed up development by letting AI perform blockchain queries that would normally require manual steps. @@ -38,20 +38,20 @@ Specifically, it enables you to: This tutorial will guide you through setting up and using Flow MCP in [Cursor] to enhance your Flow blockchain development experience with AI assistance. -## Learning Objectives +## Learning objectives -After completing this tutorial, you should be able to: +After you complete this tutorial, you should be able to: - Configure Cursor to connect with the Flow MCP server using the MCP protocol. - Install and launch the Flow MCP server locally through Cursor. -- Identify when Flow MCP tools are successfully loaded and ready inside Cursor. +- Identify when Flow MCP tools successfully load and are ready inside Cursor. - Use Flow MCP tools to retrieve blockchain data such as account balances, account details, and contract source code. - Troubleshoot common setup and connectivity issues between Cursor and Flow MCP. ## Prerequisites -- [Cursor] - the AI code editor -- [Flow MCP GitHub Repository] - the Flow MCP server repository +- [Cursor] - the AI code editor. +- [Flow MCP GitHub Repository] - the Flow MCP server repository. ## Installation @@ -82,21 +82,21 @@ After completing this tutorial, you should be able to: 3. Restart Cursor to load the new MCP configuration. - 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. + 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. ![Flow MCP server ready](./imgs/flow-mcp-enabled.png) ## How to use Flow MCP in Cursor -### Checking Flow Balance +### Check Flow balance ![Sample Image 1](./imgs/sample-1.png) -### Viewing Account Information +### View account information ![Sample Image 2](./imgs/sample-2.png) -### Getting Contract Source Code +### Get contract source code ![Sample Image 3](./imgs/sample-3.png) @@ -104,13 +104,13 @@ After completing this tutorial, you should be able to: If you encounter any issues: -1. Ensure the MCP server is properly installed -2. Verify the configuration file is in the correct location -3. Check that the paths in the configuration are correct -4. Try restarting Cursor -5. Check the console for any error messages +1. Ensure the MCP server is properly installed. +2. Verify the configuration file is in the correct location. +3. Check that the paths in the configuration are correct. +4. Try restarting Cursor. +5. Check the console for any error messages. -## Additional Resources +## Additional resources - [Flow MCP GitHub Repository] - [Cursor Documentation] @@ -120,8 +120,8 @@ If you encounter any issues: For issues or questions: -- Open an issue on the [Flow MCP GitHub Repository] -- Join the [Flow Discord] community +- Open an issue on the [Flow MCP GitHub Repository]. +- Join the [Flow Discord] community. [Cursor]: https://www.cursor.com/ [Flow MCP GitHub Repository]: https://github.com/outblock/flow-mcp