mirror of
https://github.com/mcp-use/mcp-use.git
synced 2026-09-14 18:06:01 +08:00
Pietro Zullo
8348c59a53
* docs: reorganize navigation and clean up content - Remove 'Misc' group with misplaced blog posts - Remove 'Libraries' redirect group from Home nav - Simplify 'Dev Tools' group (flatten Inspector, CLI, Tunneling) - Remove individual changelog versions from Python nav (keep summary) - Remove changelog from TypeScript 'Get Started' group - Remove tunneling duplicate from Python Development group - Rewrite mcp101 as clean MCP concepts page (was pitch deck) - Delete typescript/blog posts (not technical docs) - Add redirects for deleted blog post URLs * docs: fix content accuracy and remove sloppy language - Fix broken python/server/mcp-apps link in home page - Remove informal pitch-speak from python/server/index.mdx - Fix grammar error in typescript/server/index.mdx - Update typescript/client/logging.mdx: remove fake 'coming soon' API code - Fix non-existent model name gpt-5.1 in typescript quickstart - Fix mcp_use naming in development contributing guide * docs: fix incorrect TypeScript server API calls in inspector docs - Replace server.addTool() with server.tool() (correct mcp-use API) - Add missing zod import to debugging-chatgpt-apps example * docs: fix fake model names (gpt-5.1 → gpt-4o) in agent docs * docs: update model names, fix APIs, and add agent visibility hints - Replace all deprecated model names with latest: gpt-4.1, gpt-4.1-mini, claude-sonnet-4-6, claude-opus-4-7, gemini-2.5-flash across all docs - Fix TypeScript server.tool() API in installation.mdx (old positional string form) - Fix TypeScript agent.run() in quickstart.mdx (deprecated string form → object) - Remove broken manufact.com/docs/llms.txt hidden hints from 5 pages - Add <Visibility for="agents"> block to mcp101.mdx with install commands, key classes, and API signatures for agent-oriented navigation - Add LangChain provider install note to Python quickstart (mcp-use agent requires a separate langchain-* provider package) - Update model name cards in Python llm-integration.mdx * docs: clean up remaining stale model names and improve accuracy - Update supported model lists in Python and TypeScript llm-integration pages - Fix cost optimization table to use current model IDs - Update TypeScript agent overview supported providers list * docs: add LangChain provider install to TypeScript quickstart agent section The MCPAgent requires a separate @langchain/* provider package; this was not mentioned before the code example that imports from @langchain/openai. * docs: update to latest flagship model IDs (May 2026) - OpenAI: gpt-4.1 → gpt-5.5, gpt-4.1-mini → gpt-5.5-mini - Google: gemini-2.5-flash → gemini-3.1-flash, gemini-2.5-pro → gemini-3.1-pro - Groq: llama-3.1-* → llama-4-scout-17b-16e-instruct - Anthropic (claude-opus-4-7, claude-sonnet-4-6) already current, no change * docs: replace all em dashes with hyphens * docs: restore llms.txt hints using Visibility component * docs: simplify TypeScript logging page to unsupported notice only * docs: rewrite mcp101 to explain MCP protocol with mcp-use examples and doc links * docs: remove goal.md * docs: revert nav changes, keep only Misc group removal and blog redirects * docs: reorder mcp101 to Server/App -> Client/Inspector -> Agent, restore title * docs: add code examples for Resources and Prompts in mcp101 * docs: remove em dashes from mcp101 * docs: add MCPClient code examples to mcp101 * docs: add React client example to mcp101 * docs: add agent code examples to mcp101 * docs: expand MCP Apps section in mcp101 with example and links * docs: restore Contacts, Socials, and Founders sections to mcp101 * docs: add context-setting intro paragraph to mcp101 for new readers * docs: add MCP stores section to mcp101 intro with Claude, ChatGPT, Cursor * docs: fix Claude store link * docs: fix ChatGPT store link * docs: fix Cursor store link * docs: replace store Cards with linked image grid * docs: add captions to store images * docs: add Notifications to client primitives table in mcp101 * docs: add lead-in paragraph before resource cards at bottom of mcp101 * docs: move resource cards to end of page after Contacts/Socials/Founders * docs: demote Contacts/Socials/Founders to bold text to remove from TOC * docs: move Contacts/Socials/Founders to very end of mcp101 * docs: add Resources and Contacts section headers, link official MCP docs * chore(docs): update site metadata, footer links, and rename mcp_use to mcp-use * update docs metadata + images * docs: enhance MCP section by highlighting the reach of MCP stores with 1 billion weekly active users * api ref
121 lines
2.3 KiB
Plaintext
121 lines
2.3 KiB
Plaintext
---
|
|
title: Development
|
|
description: "Contributing to mcp-use"
|
|
icon: "code"
|
|
---
|
|
|
|
This guide will help you set up your development environment and contribute to mcp-use.
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.11 or higher
|
|
- Git
|
|
- Node.js and npm (for MCP server dependencies)
|
|
|
|
## Setting Up Development Environment
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/mcp-use/mcp-use.git
|
|
cd mcp-use/libraries/python
|
|
```
|
|
|
|
2. Install development dependencies:
|
|
|
|
```bash
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
3. Install pre-commit hooks:
|
|
|
|
```bash
|
|
pre-commit install
|
|
```
|
|
|
|
## Code Style
|
|
|
|
mcp_use uses Ruff for code formatting and linting. The project follows these style guidelines:
|
|
|
|
- Use type hints for all function parameters and return values
|
|
- Follow PEP 8 style guide
|
|
- Use docstrings for all public functions and classes
|
|
- Keep functions focused and single-purpose
|
|
|
|
## Running Tests
|
|
|
|
The project uses pytest for testing. To run the test suite:
|
|
|
|
```bash
|
|
pytest
|
|
```
|
|
|
|
For more specific test runs:
|
|
|
|
```bash
|
|
# Run tests with coverage
|
|
pytest --cov=mcp_use
|
|
|
|
# Run specific test file
|
|
pytest tests/test_client.py
|
|
|
|
# Run tests with verbose output
|
|
pytest -v
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Documentation is written in MDX format and uses Mintlify for rendering. To preview documentation changes:
|
|
|
|
1. Install Mintlify CLI:
|
|
|
|
```bash
|
|
npm i -g mintlify
|
|
```
|
|
|
|
2. Navigate to the docs directory and run the development server:
|
|
|
|
```bash
|
|
cd ../../docs
|
|
mintlify dev
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Create a new branch for your feature:
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
2. Make your changes and commit them:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Description of your changes"
|
|
```
|
|
|
|
3. Push your changes and create a pull request:
|
|
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
mcp-use/
|
|
├── libraries/
|
|
│ ├── python/
|
|
│ │ ├── mcp_use/ # Main package code
|
|
│ │ ├── tests/ # Test files
|
|
│ │ ├── examples/ # Python examples
|
|
│ │ └── pyproject.toml # Python package configuration
|
|
│ └── typescript/
|
|
│ └── packages/
|
|
│ └── mcp-use/ # TypeScript package
|
|
├── docs/ # Documentation
|
|
├── examples/ # Additional examples
|
|
└── static/ # Static assets
|
|
```
|