返回 MCP 目录
public公开dns本地运行

Coding Project Structure

一个提供项目文件内容访问的MCP服务器,支持获取项目目录下所有文件及其内容。

article

README

🚀 项目内容服务器

项目内容服务器是一个MCP服务器,它为用户提供了访问项目文件及其内容的权限,方便对项目文件进行管理和使用。

🚀 快速开始

本项目是一个提供项目文件及其内容访问权限的MCP服务器。你可以通过以下步骤进行安装和使用。

📦 安装指南

  1. 克隆仓库。
  2. 安装依赖:
    npm install
    
  3. 构建项目:
    npm run build
    

💻 使用示例

基础用法

启动服务器:

node build/index.js

📚 详细文档

API

latest_project_data

获取项目目录中的所有文件及其内容。

参数:

  • projectPath (字符串):项目目录路径

示例请求:

{
  "name": "latest_project_data",
  "arguments": {
    "projectPath": "/path/to/project"
  }
}

示例响应:

{
  "file1.txt": "文件1的内容",
  "subdir/file2.js": "文件2的内容"
}

配置

服务器可以通过环境变量进行配置:

| 属性 | 详情 | |------|------| | PORT | 服务器运行的端口(默认:标准输出) |

错误处理

服务器返回错误信息的格式如下:

{
  "content": [{
    "type": "text",
    "text": "错误消息"
  }],
  "isError": true
}

常见的错误包括:

  • 无效的项目路径
  • 权限 denied 错误
  • 文件系统错误

📄 许可证

本项目采用MIT许可证。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端